1 #ifndef artdaq_ArtModules_TransferInterface_hh
2 #define artdaq_ArtModules_TransferInterface_hh
4 #include "artdaq-core/Data/Fragment.hh"
5 #include "artdaq/DAQdata/Globals.hh"
6 #include "cetlib/compiler_macros.h"
7 #include "fhiclcpp/ParameterSet.h"
26 fhicl::Atom<int>
source_rank{fhicl::Name{
"source_rank"}, fhicl::Comment{
"The rank that data is coming from"}, my_rank};
28 fhicl::Atom<int>
destination_rank{fhicl::Name{
"destination_rank"}, fhicl::Comment{
"The rank that data is going to"}, my_rank};
30 fhicl::Atom<std::string>
unique_label{fhicl::Name{
"unique_label"}, fhicl::Comment{
"A label that uniquely identifies the TransferInterface instance"},
"transfer_between_[source_rank]_and_[destination_rank]"};
32 fhicl::Atom<size_t>
buffer_count{fhicl::Name{
"buffer_count"}, fhicl::Comment{
"How many Fragments can the TransferInterface handle simultaneously"}, 10};
34 fhicl::Atom<size_t>
max_fragment_size{fhicl::Name{
"max_fragment_size_words"}, fhicl::Comment{
"The maximum Fragment size expected.May be used for static memory allocation, and will cause errors if larger Fragments are sent."}, 1024};
120 virtual int receiveFragment(artdaq::Fragment& fragment,
size_t receive_timeout);
185 #define GetTraceName() unique_label_ << (role_ == Role::kSend ? std::string("_SEND: ") : std::string("_RECV: "))
212 #ifndef EXTERN_C_FUNC_DECLARE_START
213 #define EXTERN_C_FUNC_DECLARE_START extern "C" {
216 #define DEFINE_ARTDAQ_TRANSFER(klass) \
217 EXTERN_C_FUNC_DECLARE_START \
218 std::unique_ptr<artdaq::TransferInterface> make(fhicl::ParameterSet const& ps, artdaq::TransferInterface::Role role) \
220 return std::unique_ptr<artdaq::TransferInterface>(new klass(ps, role)); \
size_t buffer_count_
The number of Fragment transfers the TransferInterface can handle simultaneously. ...
ReceiveReturnCode
Return codes from receive operations
virtual int receiveFragmentHeader(detail::RawFragmentHeader &header, size_t receiveTimeout)=0
Receive a Fragment Header from the transport mechanism.
virtual int source_rank() const
Get the source rank for this TransferInterface instance.
TransferInterface & operator=(const TransferInterface &)=delete
Copy Assignment operator is deleted.
Role role() const
Get the TransferInterface::Role of this TransferInterface.
The send operation timed out.
const std::string unique_label_
Unique label of transfer (ideally the same on sender and receiver)
virtual ~TransferInterface()=default
Default virtual Destructor.
This TransferInterface is a Receiver.
virtual void flush_buffers()=0
Flush any in-flight data. This should be used by the receiver after the receive loop has ended...
const int destination_rank_
Rank of destination.
static std::string CopyStatusToString(CopyStatus in)
Convert a CopyStatus variable to its string represenatation
virtual int receiveFragmentData(RawDataType *destination, size_t wordCount)=0
Receive the body of a Fragment to the given destination pointer.
fhicl::Atom< std::string > unique_label
"unique_label" (Default: "transfer_between_[source_rank]_and_[destination_rank]") : A label that uniq...
Value that is to be returned when a Transfer plugin determines that no more data will be arriving...
Configuration of the TransferInterface. May be used for parameter validation
virtual bool isRunning()
Determine whether the TransferInterface plugin is able to send/receive data.
This TransferInterface is a Sender.
fhicl::Atom< size_t > max_fragment_size
"max_fragment_size_words" (Default: 1024) : The maximum Fragment size expected.May be used for static...
virtual CopyStatus transfer_fragment_reliable_mode(artdaq::Fragment &&fragment)=0
Transfer a Fragment to the destination. This should be reliable, if the underlying transport mechanis...
Some error occurred, but no exception was thrown.
Role
Used to determine if a TransferInterface is a Sender or Receiver.
Will be returned from a successful receive that does not know the source rank (Transfer to OM art pro...
The send operation completed successfully.
std::string uniqueLabel() const
Get the unique label of this TransferInterface instance.
fhicl::WrappedTable< Config > Parameters
Used for ParameterSet validation (if desired)
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 th...
This interface defines the functions used to transfer data between artdaq applications.
virtual int destination_rank() const
Get the destination rank for this TransferInterface instance.
fhicl::Atom< size_t > buffer_count
"buffer_count" (Default: 10) : How many Fragments can the TransferInterface handle simultaneously ...
TransferInterface(const fhicl::ParameterSet &ps, Role role)
TransferInterface Constructor.
For code clarity, things checking for successful receive should check retval >= NO_RANK_INFO.
const Role role_
Whether this instance of TransferInterface is a sender or receiver.
fhicl::Atom< int > source_rank
"source_rank" (Default: my_rank) : The rank that data is coming from
fhicl::Atom< int > destination_rank
"destination_rank" (Default: my_rank) : The rank that data is going to
Value to be returned upon receive timeout.
virtual int receiveFragment(artdaq::Fragment &fragment, size_t receive_timeout)
Receive a Fragment from the transport mechanism.
CopyStatus
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.
const size_t max_fragment_size_words_
The maximum size of the transferred Fragment objects, in artdaq::Fragment::RawDataType words...
const int source_rank_
Rank of source.