$treeview $search $mathjax $extrastylesheet
artdaq  v3_04_01
$projectbrief
$projectbrief
$searchbox

artdaq::NullTransfer Class Reference

NullTransfer does not send or receive data, but acts as if it did. More...

Inheritance diagram for artdaq::NullTransfer:
artdaq::TransferInterface

List of all members.

Public Member Functions

 NullTransfer (const fhicl::ParameterSet &pset, Role role)
 NullTransfer constructor.
virtual ~NullTransfer ()
 NullTransfer default Destructor.
int receiveFragment (artdaq::Fragment &, size_t) override
 Pretend to receive a Fragment.
int receiveFragmentHeader (detail::RawFragmentHeader &, size_t) override
 Pretend to receive a Fragment Header.
int receiveFragmentData (RawDataType *, size_t) override
 Pretend to receive Fragment Data.
CopyStatus transfer_fragment_min_blocking_mode (artdaq::Fragment const &, size_t) override
 Pretend to send a Fragment to a destination.
CopyStatus transfer_fragment_reliable_mode (artdaq::Fragment &&) override
 Pretend to send a Fragment to a destination.
bool isRunning () override
 Determine whether the TransferInterface plugin is able to send/receive data.
void flush_buffers () override
 Flush any in-flight data. This should be used by the receiver after the receive loop has ended.

Detailed Description

NullTransfer does not send or receive data, but acts as if it did.

Definition at line 7 of file Null_transfer.cc.


Constructor & Destructor Documentation

artdaq::NullTransfer::NullTransfer ( const fhicl::ParameterSet &  pset,
Role  role 
)

NullTransfer constructor.

Parameters:
pset ParameterSet used to configure TransferInterface
role Role of this NullTransfer instance (kSend or kReceive)

NullTransfer only requires the Parameters for configuring a TransferInterface

Definition at line 78 of file Null_transfer.cc.


Member Function Documentation

bool artdaq::NullTransfer::isRunning (  )  [inline, override, virtual]

Determine whether the TransferInterface plugin is able to send/receive data.

Returns:
True if the TransferInterface plugin is currently able to send/receive data

Reimplemented from artdaq::TransferInterface.

Definition at line 68 of file Null_transfer.cc.

int artdaq::NullTransfer::receiveFragment ( artdaq::Fragment &  ,
size_t   
) [inline, override, virtual]

Pretend to receive a Fragment.

Returns:
Source Rank (Success code)

WARNING: This function may create unintended side-effets. NullTransfer should only really be used in Role::kSend!

Reimplemented from artdaq::TransferInterface.

Definition at line 30 of file Null_transfer.cc.

int artdaq::NullTransfer::receiveFragmentData ( RawDataType *  ,
size_t   
) [inline, override, virtual]

Pretend to receive Fragment Data.

Returns:
Source Rank (Success code)

WARNING: This function may create unintended side-effets. NullTransfer should only really be used in Role::kSend!

Implements artdaq::TransferInterface.

Definition at line 48 of file Null_transfer.cc.

int artdaq::NullTransfer::receiveFragmentHeader ( detail::RawFragmentHeader &  ,
size_t   
) [inline, override, virtual]

Pretend to receive a Fragment Header.

Returns:
Source Rank (Success code)

WARNING: This function may create unintended side-effets. NullTransfer should only really be used in Role::kSend!

Implements artdaq::TransferInterface.

Definition at line 39 of file Null_transfer.cc.

CopyStatus artdaq::NullTransfer::transfer_fragment_min_blocking_mode ( artdaq::Fragment const &  ,
size_t   
) [inline, override, virtual]

Pretend to send a Fragment to a destination.

Returns:
CopyStatus::kSuccess (No-Op)

Implements artdaq::TransferInterface.

Definition at line 54 of file Null_transfer.cc.

CopyStatus artdaq::NullTransfer::transfer_fragment_reliable_mode ( artdaq::Fragment &&   )  [inline, override, virtual]

Pretend to send a Fragment to a destination.

Returns:
CopyStatus::kSuccess (No-Op)

Implements artdaq::TransferInterface.

Definition at line 62 of file Null_transfer.cc.


The documentation for this class was generated from the following file:

Generated on 29 Mar 2019 for artdaq by  doxygen 1.6.1