artdaq
v3_06_00
|
Receive data requests and make them available to CommandableFragmentGenerator or other interested parties. Track received requests and report errors when inconsistency is detected. More...
#include <artdaq/DAQrate/RequestReceiver.hh>
Classes | |
struct | Config |
Configuration of the RequestReceiver. May be used for parameter validation More... | |
Public Types | |
using | Parameters = fhicl::WrappedTable< Config > |
Used for ParameterSet validation (if desired) | |
Public Member Functions | |
RequestReceiver () | |
RequestReceiver Default Constructor. | |
RequestReceiver (const fhicl::ParameterSet &ps) | |
RequestReceiver Constructor. More... | |
void | setupRequestListener () |
Opens the socket used to listen for data requests. | |
void | stopRequestReception (bool force=false) |
Disables (stops) the reception of data requests. More... | |
void | startRequestReception () |
Enables (starts) the reception of data requests. | |
void | receiveRequestsLoop () |
This function receives data request packets, adding new requests to the request list. | |
std::map < artdaq::Fragment::sequence_id_t, artdaq::Fragment::timestamp_t > | GetRequests () const |
Get the current requests More... | |
void | RemoveRequest (artdaq::Fragment::sequence_id_t reqID) |
Remove the request with the given sequence ID from the request map More... | |
bool | isRunning () |
Determine if the RequestReceiver is receiving requests More... | |
void | ClearRequests () |
Clear all requests from the map More... | |
std::map < artdaq::Fragment::sequence_id_t, artdaq::Fragment::timestamp_t > | GetAndClearRequests () |
Get the current requests, then clear the map More... | |
size_t | size () |
Get the number of requests currently stored in the RequestReceiver More... | |
bool | WaitForRequests (int timeout_ms) |
Wait for a new request message, up to the timeout given More... | |
std::chrono::steady_clock::time_point | GetRequestTime (artdaq::Fragment::sequence_id_t reqID) |
Get the time a given request was received More... | |
void | SetRunNumber (uint32_t run) |
Sets the current run number More... | |
Receive data requests and make them available to CommandableFragmentGenerator or other interested parties. Track received requests and report errors when inconsistency is detected.
Definition at line 18 of file RequestReceiver.hh.
artdaq::RequestReceiver::RequestReceiver | ( | const fhicl::ParameterSet & | ps | ) |
RequestReceiver Constructor.
ps | ParameterSet used to configure RequestReceiver. See artdaq::RequestReceiver::Config |
Definition at line 52 of file RequestReceiver.cc.
|
inline |
Clear all requests from the map
Definition at line 104 of file RequestReceiver.hh.
|
inline |
Get the current requests, then clear the map
Definition at line 114 of file RequestReceiver.hh.
|
inline |
Get the current requests
Definition at line 78 of file RequestReceiver.hh.
|
inline |
Get the time a given request was received
reqID | Request ID of the request |
Definition at line 157 of file RequestReceiver.hh.
|
inline |
Determine if the RequestReceiver is receiving requests
Definition at line 99 of file RequestReceiver.hh.
void artdaq::RequestReceiver::RemoveRequest | ( | artdaq::Fragment::sequence_id_t | reqID | ) |
Remove the request with the given sequence ID from the request map
reqID | Request ID to remove |
Definition at line 296 of file RequestReceiver.cc.
|
inline |
Sets the current run number
run | The current run number |
Definition at line 167 of file RequestReceiver.hh.
|
inline |
Get the number of requests currently stored in the RequestReceiver
Definition at line 133 of file RequestReceiver.hh.
void artdaq::RequestReceiver::stopRequestReception | ( | bool | force = false | ) |
Disables (stops) the reception of data requests.
force | Whether to suppress any error messages (used if called from destructor) |
Definition at line 130 of file RequestReceiver.cc.
|
inline |
Wait for a new request message, up to the timeout given
timeout_ms | Milliseconds to wait for a new request to arrive |
Definition at line 143 of file RequestReceiver.hh.