Receives event builder "free buffer" tokens and adds them to a specified RoutingPolicy.
More...
#include <artdaq/DAQrate/TokenReceiver.hh>
|
using | Parameters = fhicl::WrappedTable< Config > |
| Used for ParameterSet validation (if desired)
|
|
Receives event builder "free buffer" tokens and adds them to a specified RoutingPolicy.
Definition at line 18 of file TokenReceiver.hh.
TokenReceiver Constructor.
- Parameters
-
ps | ParameterSet used to configure TokenReceiver. See artdaq::TokenReceiver::Config |
policy | RoutingManagerPolicy that manages the received tokens |
routing_mode | Whether routing should occur by Sequence ID (i.e. BR->EB), or by send count (EB->DL). RouteBySendCount assumes no event building on receiver |
number_of_senders | For RouteBySendCount routing mode, the number of tokens needed to issue a new routing table entry |
update_interval_msec | The amount of time to wait in epoll_wait for a new update to arrive |
Definition at line 12 of file TokenReceiver.cc.
size_t artdaq::TokenReceiver::getReceivedTokenCount |
( |
| ) |
const |
|
inline |
Returns the number of tokens that have been received.
- Returns
- The number of tokens that have been received since the most recent start
Definition at line 90 of file TokenReceiver.hh.
void artdaq::TokenReceiver::setRunNumber |
( |
uint32_t |
run | ) |
|
|
inline |
Sets the current run number.
- Parameters
-
run | The current run number |
Definition at line 84 of file TokenReceiver.hh.
void artdaq::TokenReceiver::setStatsHelper |
( |
std::shared_ptr< StatisticsHelper > const & |
helper, |
|
|
std::string const & |
stat_key |
|
) |
| |
|
inline |
Specifies a StatisticsHelper instance to use when gathering statistics.
- Parameters
-
helper | A shared pointer to the StatisticsHelper instance |
stat_key | Name to use for gathering statistics on tokens received |
Definition at line 74 of file TokenReceiver.hh.
void artdaq::TokenReceiver::stopTokenReception |
( |
bool |
force = false | ) |
|
Stops the reception of event builder tokens.
- Parameters
-
force | Whether to suppress any error messages (used if called from destructor) |
Definition at line 63 of file TokenReceiver.cc.
The documentation for this class was generated from the following files: