artdaq::RequestSender Class Reference

The RequestSender contains methods used to send data requests and Routing tokens. More...

#include <artdaq/DAQrate/RequestSender.hh>

List of all members.

Classes

struct  Config
 Configuration of the RequestSender. May be used for parameter validation. More...
struct  RoutingTokenConfig
 Configuration for Routing token sending. More...

Public Member Functions

 RequestSender ()
 Default Constructor is deleted.
 RequestSender (RequestSender const &)
 Copy Constructor is deleted.
RequestSenderoperator= (RequestSender const &)
 Copy Assignment operator is deleted.
 RequestSender (const fhicl::ParameterSet &pset)
 RequestSender Constructor.
virtual ~RequestSender ()
 RequestSender Destructor.
void SetRequestMode (detail::RequestMessageMode mode)
 Set the mode for RequestMessages. Used to indicate when RequestSender should enter "EndOfRun" mode.
detail::RequestMessageMode GetRequestMode () const
 Get the mode for RequestMessages.
void SendRequest (bool endOfRunOnly=false)
 Send a request message containing all current requests.
void AddRequest (Fragment::sequence_id_t seqID, Fragment::timestamp_t timestamp)
 Add a request to the request list.
void RemoveRequest (Fragment::sequence_id_t seqID)
 Remove a request from the request list.
void SendRoutingToken (int nSlots)
 Send a RoutingToken message indicating that slots are available.
size_t GetSentTokenCount () const
 Get the count of number of tokens sent.

Detailed Description

The RequestSender contains methods used to send data requests and Routing tokens.

Definition at line 27 of file RequestSender.hh.


Constructor & Destructor Documentation

artdaq::RequestSender::RequestSender ( const fhicl::ParameterSet &  pset  ) 

RequestSender Constructor.

Parameters:
pset ParameterSet used to configured RequestSender. See artdaq::RequestSender::Config

Definition at line 20 of file RequestSender.cc.


Member Function Documentation

void artdaq::RequestSender::AddRequest ( Fragment::sequence_id_t  seqID,
Fragment::timestamp_t  timestamp 
)

Add a request to the request list.

Parameters:
seqID Sequence ID for request
timestamp Timestamp to request

Definition at line 256 of file RequestSender.cc.

detail::RequestMessageMode artdaq::RequestSender::GetRequestMode (  )  const [inline]

Get the mode for RequestMessages.

Returns:
Current RequestMessageMode of the RequestSender

Definition at line 103 of file RequestSender.hh.

size_t artdaq::RequestSender::GetSentTokenCount (  )  const [inline]

Get the count of number of tokens sent.

Returns:
The number of tokens sent by RequestSender

Definition at line 134 of file RequestSender.hh.

RequestSender& artdaq::RequestSender::operator= ( RequestSender const &   ) 

Copy Assignment operator is deleted.

Returns:
RequestSender copy
void artdaq::RequestSender::RemoveRequest ( Fragment::sequence_id_t  seqID  ) 

Remove a request from the request list.

Parameters:
seqID Sequence ID of request

Definition at line 270 of file RequestSender.cc.

void artdaq::RequestSender::SendRequest ( bool  endOfRunOnly = false  ) 

Send a request message containing all current requests.

Parameters:
endOfRunOnly Whether the request should only be sent in EndOfRun RequestMessageMode (default: false)

Definition at line 245 of file RequestSender.cc.

void artdaq::RequestSender::SendRoutingToken ( int  nSlots  ) 

Send a RoutingToken message indicating that slots are available.

Parameters:
nSlots Number of slots available

Definition at line 236 of file RequestSender.cc.

void artdaq::RequestSender::SetRequestMode ( detail::RequestMessageMode  mode  ) 

Set the mode for RequestMessages. Used to indicate when RequestSender should enter "EndOfRun" mode.

Parameters:
mode Mode to set

Definition at line 75 of file RequestSender.cc.


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

Generated on 24 Sep 2018 for artdaq by  doxygen 1.6.1