artdaq  v3_09_01
artdaq::RequestReceiver Class Reference

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, std::shared_ptr< RequestBuffer > output_buffer)
 RequestReceiver Constructor. More...
 
virtual ~RequestReceiver ()
 RequestReceiver Destructor.
 
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.
 
bool isRunning ()
 Determine if the RequestReceiver is receiving requests More...
 
void SetRunNumber (uint32_t run)
 Sets the current run number More...
 

Detailed Description

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.

Constructor & Destructor Documentation

artdaq::RequestReceiver::RequestReceiver ( const fhicl::ParameterSet &  ps,
std::shared_ptr< RequestBuffer output_buffer 
)

RequestReceiver Constructor.

Parameters
psParameterSet used to configure RequestReceiver. See artdaq::RequestReceiver::Config

Definition at line 42 of file RequestReceiver.cc.

Member Function Documentation

bool artdaq::RequestReceiver::isRunning ( )
inline

Determine if the RequestReceiver is receiving requests

Returns
True if the request receiver is running

Definition at line 81 of file RequestReceiver.hh.

void artdaq::RequestReceiver::SetRunNumber ( uint32_t  run)
inline

Sets the current run number

Parameters
runThe current run number

Definition at line 87 of file RequestReceiver.hh.

void artdaq::RequestReceiver::stopRequestReception ( bool  force = false)

Disables (stops) the reception of data requests.

Parameters
forceWhether to suppress any error messages (used if called from destructor)

Definition at line 120 of file RequestReceiver.cc.


The documentation for this class was generated from the following files: