artdaq
v3_06_00
|
This interface defines the functions used to transfer data between artdaq applications. More...
#include <artdaq/TransferPlugins/TransferInterface.hh>
Classes | |
struct | Config |
Configuration of the TransferInterface. May be used for parameter validation More... | |
Public Types | |
enum | ReceiveReturnCode : int { DATA_END = -2222, RECV_TIMEOUT = -1111, NO_RANK_INFO = -1, RECV_SUCCESS = 0 } |
Return codes from receive operations More... | |
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... | |
using | Parameters = fhicl::WrappedTable< Config > |
Used for ParameterSet validation (if desired) | |
Public Member Functions | |
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. | |
virtual int | receiveFragment (artdaq::Fragment &fragment, size_t receiveTimeout) |
Receive a Fragment from the transport mechanism. More... | |
virtual int | receiveFragmentHeader (detail::RawFragmentHeader &header, size_t receiveTimeout)=0 |
Receive a Fragment Header from the transport mechanism. More... | |
virtual int | receiveFragmentData (RawDataType *destination, size_t wordCount)=0 |
Receive the body of a Fragment to the given destination pointer. More... | |
virtual CopyStatus | transfer_fragment_min_blocking_mode (artdaq::Fragment const &fragment, size_t send_timeout_usec)=0 |
Transfer a Fragment to the destination. May not necessarily be reliable, but will not block longer than send_timeout_usec. More... | |
virtual CopyStatus | transfer_fragment_reliable_mode (artdaq::Fragment &&fragment)=0 |
Transfer a Fragment to the destination. This should be reliable, if the underlying transport mechanism supports reliable sending. More... | |
std::string | uniqueLabel () const |
Get the unique label of this TransferInterface instance. More... | |
virtual int | source_rank () const |
Get the source rank for this TransferInterface instance. More... | |
virtual int | destination_rank () const |
Get the destination rank for this TransferInterface instance. More... | |
virtual bool | isRunning () |
Determine whether the TransferInterface plugin is able to send/receive data. More... | |
virtual void | flush_buffers ()=0 |
Flush any in-flight data. This should be used by the receiver after the receive loop has ended. | |
Static Public Member Functions | |
static std::string | CopyStatusToString (CopyStatus in) |
Convert a CopyStatus variable to its string represenatation More... | |
Protected Member Functions | |
Role | role () const |
Get the TransferInterface::Role of this TransferInterface. More... | |
Protected Attributes | |
const Role | role_ |
Whether this instance of TransferInterface is a sender or receiver. | |
const int | source_rank_ |
Rank of source. | |
const int | destination_rank_ |
Rank of destination. | |
const std::string | unique_label_ |
Unique label of transfer (ideally the same on sender and receiver) | |
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. | |
This interface defines the functions used to transfer data between artdaq applications.
Definition at line 18 of file TransferInterface.hh.
|
strong |
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.
Enumerator | |
---|---|
kSuccess |
The send operation completed successfully. |
kTimeout |
The send operation timed out. |
kErrorNotRequiringException |
Some error occurred, but no exception was thrown. |
Definition at line 64 of file TransferInterface.hh.
enum artdaq::TransferInterface::ReceiveReturnCode : int |
Return codes from receive operations
Definition at line 43 of file TransferInterface.hh.
|
strong |
Used to determine if a TransferInterface is a Sender or Receiver.
Enumerator | |
---|---|
kSend |
This TransferInterface is a Sender. |
kReceive |
This TransferInterface is a Receiver. |
Definition at line 54 of file TransferInterface.hh.
artdaq::TransferInterface::TransferInterface | ( | const fhicl::ParameterSet & | ps, |
Role | role | ||
) |
TransferInterface Constructor.
ps | ParameterSet used for configuring the TransferInterface. See artdaq::TransferInterface::Config |
role | Role of the TransferInterface (See TransferInterface::Role) |
Definition at line 7 of file TransferInterface.cc.
|
inlinestatic |
Convert a CopyStatus variable to its string represenatation
in | CopyStatus to convert |
Definition at line 76 of file TransferInterface.hh.
|
inlinevirtual |
Get the destination rank for this TransferInterface instance.
Definition at line 168 of file TransferInterface.hh.
|
inlinevirtual |
Determine whether the TransferInterface plugin is able to send/receive data.
Reimplemented in artdaq::MulticastTransfer, artdaq::TCPSocketTransfer, artdaq::AutodetectTransfer, artdaq::ShmemTransfer, artdaq::RTIDDSTransfer, and artdaq::NullTransfer.
Definition at line 174 of file TransferInterface.hh.
|
delete |
Copy Assignment operator is deleted.
|
virtual |
Receive a Fragment from the transport mechanism.
[out] | fragment | Received Fragment |
receiveTimeout | Timeout for receive |
Reimplemented in artdaq::MulticastTransfer, artdaq::RTIDDSTransfer, artdaq::AutodetectTransfer, and artdaq::NullTransfer.
Definition at line 19 of file TransferInterface.cc.
|
pure virtual |
Receive the body of a Fragment to the given destination pointer.
destination | Pointer to memory region where Fragment data should be stored |
wordCount | Number of words of Fragment data to receive |
The precondition for calling this function is that you have received a valid header, therefore it does not have a , as the Fragment data should immediately be available.
Implemented in artdaq::MulticastTransfer, artdaq::TCPSocketTransfer, artdaq::ShmemTransfer, artdaq::AutodetectTransfer, and artdaq::NullTransfer.
|
pure virtual |
Receive a Fragment Header from the transport mechanism.
[out] | header | Received Fragment Header |
receiveTimeout | Timeout for receive |
Implemented in artdaq::MulticastTransfer, artdaq::TCPSocketTransfer, artdaq::ShmemTransfer, artdaq::AutodetectTransfer, and artdaq::NullTransfer.
|
inlineprotected |
Get the TransferInterface::Role of this TransferInterface.
Definition at line 201 of file TransferInterface.hh.
|
inlinevirtual |
Get the source rank for this TransferInterface instance.
Definition at line 163 of file TransferInterface.hh.
|
pure virtual |
Transfer a Fragment to the destination. May not necessarily be reliable, but will not block longer than send_timeout_usec.
fragment | Fragment to transfer |
send_timeout_usec | Timeout for send, in microseconds |
Implemented in artdaq::MulticastTransfer, artdaq::AutodetectTransfer, artdaq::RTIDDSTransfer, and artdaq::NullTransfer.
|
pure virtual |
Transfer a Fragment to the destination. This should be reliable, if the underlying transport mechanism supports reliable sending.
fragment | Fragment to transfer |
Implemented in artdaq::MulticastTransfer, artdaq::AutodetectTransfer, artdaq::RTIDDSTransfer, and artdaq::NullTransfer.
|
inline |
Get the unique label of this TransferInterface instance.
Definition at line 157 of file TransferInterface.hh.