artdaq
v2_02_03
|
NullTransfer does not send or receive data, but acts as if it did. More...
Public Member Functions | |
NullTransfer (const fhicl::ParameterSet &pset, Role role) | |
NullTransfer constructor. More... | |
virtual | ~NullTransfer ()=default |
NullTransfer default Destructor. | |
int | receiveFragment (artdaq::Fragment &, size_t) override |
Pretend to receive a Fragment. More... | |
CopyStatus | copyFragment (artdaq::Fragment &, size_t) override |
Pretend to copy a Fragment to a destination. More... | |
CopyStatus | moveFragment (artdaq::Fragment &&, size_t) override |
Pretend to move a Fragment to a destination. More... | |
![]() | |
TransferInterface (const fhicl::ParameterSet &ps, Role role) | |
TransferInterface Constructor. More... | |
TransferInterface (const TransferInterface &)=delete | |
Copy Constructor is deleted. | |
TransferInterface & | operator= (const TransferInterface &)=delete |
Copy Assignment operator is deleted. More... | |
virtual | ~TransferInterface ()=default |
Default virtual Destructor. | |
std::string | uniqueLabel () const |
Get the unique label of this TransferInterface instance. More... | |
int | source_rank () const |
Get the source rank for this TransferInterface instance. More... | |
int | destination_rank () const |
Get the destination rank for this TransferInterface instance. More... | |
Additional Inherited Members | |
![]() | |
enum | Role { Role::kSend, Role::kReceive } |
Used to determine if a TransferInterface is a Sender or Receiver. More... | |
enum | CopyStatus { CopyStatus::kSuccess, CopyStatus::kTimeout, CopyStatus::kErrorNotRequiringException } |
Returned from the send functions, this enumeration describes the possible return codes. If an exception occurs, it will be thrown and should be handled normally. More... | |
![]() | |
static const int | RECV_TIMEOUT = 0xfedcba98 |
Value to be returned upon receive timeout. Because receivers otherwise return rank, this is also the limit on the number of ranks that artdaq currently supports. | |
![]() | |
Role | role () const |
Get the TransferInterface::Role of this TransferInterface. More... | |
![]() | |
size_t | buffer_count_ |
The number of Fragment transfers the TransferInterface can handle simultaneously. | |
const size_t | max_fragment_size_words_ |
The maximum size of the transferred Fragment objects, in artdaq::Fragment::RawDataType words. | |
NullTransfer does not send or receive data, but acts as if it did.
Definition at line 8 of file Null_transfer.cc.
artdaq::NullTransfer::NullTransfer | ( | const fhicl::ParameterSet & | pset, |
Role | role | ||
) |
NullTransfer constructor.
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 57 of file Null_transfer.cc.
|
inlineoverridevirtual |
Pretend to copy a Fragment to a destination.
Implements artdaq::TransferInterface.
Definition at line 41 of file Null_transfer.cc.
|
inlineoverridevirtual |
Pretend to move a Fragment to a destination.
Implements artdaq::TransferInterface.
Definition at line 50 of file Null_transfer.cc.
|
inlineoverridevirtual |
Pretend to receive a Fragment.
WARNING: This function may create unintended side-effets. NullTransfer should only really be used in Role::kSend!
Implements artdaq::TransferInterface.
Definition at line 32 of file Null_transfer.cc.