artdaq  v3_12_02
artdaq::TokenSender Class Reference

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

#include <artdaq/DAQrate/detail/TokenSender.hh>

Classes

struct  Config
 Configuration for Routing token sending More...
 

Public Types

using Parameters = fhicl::WrappedTable< Config >
 Used for ParameterSet validation (if desired)
 

Public Member Functions

 TokenSender ()=delete
 Default Constructor is deleted.
 
 TokenSender (TokenSender const &)=delete
 Copy Constructor is deleted.
 
TokenSenderoperator= (TokenSender const &)=delete
 Copy Assignment operator is deleted. More...
 
 TokenSender (TokenSender &&)=delete
 Move Constructor is deleted.
 
TokenSenderoperator= (TokenSender &&)=delete
 Move-assignment operator is deleted.
 
 TokenSender (const fhicl::ParameterSet &pset)
 TokenSender Constructor. More...
 
virtual ~TokenSender ()
 TokenSender Destructor.
 
void SendRoutingToken (int nSlots, int run_number, int rank=my_rank)
 Send a RoutingToken message indicating that slots are available. More...
 
size_t GetSentTokenCount () const
 Get the count of number of tokens sent. More...
 
void SetRunNumber (uint32_t run)
 Set the run number to be used in request messages. More...
 
bool RoutingTokenSendsEnabled ()
 Determine if routing token sends are enabled. More...
 

Detailed Description

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

Definition at line 28 of file TokenSender.hh.

Constructor & Destructor Documentation

artdaq::TokenSender::TokenSender ( const fhicl::ParameterSet &  pset)
explicit

TokenSender Constructor.

Parameters
psetParameterSet used to configured TokenSender. See artdaq::TokenSender::Config

Definition at line 18 of file TokenSender.cc.

Member Function Documentation

size_t artdaq::TokenSender::GetSentTokenCount ( ) const
inline

Get the count of number of tokens sent.

Returns
The number of tokens sent by TokenSender

Definition at line 89 of file TokenSender.hh.

TokenSender& artdaq::TokenSender::operator= ( TokenSender const &  )
delete

Copy Assignment operator is deleted.

Returns
TokenSender copy
bool artdaq::TokenSender::RoutingTokenSendsEnabled ( )
inline

Determine if routing token sends are enabled.

Returns
If routing tokens will be sent by this TokenSender

Definition at line 101 of file TokenSender.hh.

void artdaq::TokenSender::SendRoutingToken ( int  nSlots,
int  run_number,
int  rank = my_rank 
)

Send a RoutingToken message indicating that slots are available.

Parameters
nSlotsNumber of slots available
run_numberRun number for token
rankRank of token

Definition at line 113 of file TokenSender.cc.

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

Set the run number to be used in request messages.

Parameters
runRun number

Definition at line 95 of file TokenSender.hh.


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