artdaq  v3_12_02
artdaq::detail::RoutingRequest Struct Reference

Represents a request sent to the RoutingManager for routing information. More...

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

Public Types

enum  RequestMode : uint8_t { Connect = 0, Disconnect = 1, Request = 2, Invalid = 255 }
 The mode of this request, whether Request or Connect/Disconnect control messages.
 

Public Member Functions

 RoutingRequest (int r, RequestMode m=RequestMode::Connect)
 Create a request using the given rank and mode. More...
 
 RoutingRequest (int r, Fragment::sequence_id_t seq)
 Create a RoutingRequest using the given rank and sequence ID. More...
 
 RoutingRequest ()
 Default constructor.
 

Static Public Member Functions

static std::string RequestModeToString (RequestMode m)
 Convert a RequestMode enumeration value to string. More...
 

Public Attributes

uint32_t header {0}
 Magic bytes for identifying message type on wire.
 
int32_t rank {-1}
 The rank of the request sender.
 
Fragment::sequence_id_t sequence_id {artdaq::Fragment::InvalidSequenceID}
 The sequence ID being requested in Request mode.
 
RequestMode mode {RequestMode::Invalid}
 Mode of the request.
 

Detailed Description

Represents a request sent to the RoutingManager for routing information.

Definition at line 124 of file RoutingPacket.hh.

Constructor & Destructor Documentation

artdaq::detail::RoutingRequest::RoutingRequest ( int  r,
RequestMode  m = RequestMode::Connect 
)
inline

Create a request using the given rank and mode.

Parameters
rRank of the requestor
mMode of this request

This constructor is primarily used to sed RequestMode::Connect and RequestMode::Disconnect control messages

Definition at line 170 of file RoutingPacket.hh.

artdaq::detail::RoutingRequest::RoutingRequest ( int  r,
Fragment::sequence_id_t  seq 
)
inline

Create a RoutingRequest using the given rank and sequence ID.

Parameters
rRank of the requestor
seqSequence ID of request

Definition at line 178 of file RoutingPacket.hh.

Member Function Documentation

static std::string artdaq::detail::RoutingRequest::RequestModeToString ( RequestMode  m)
inlinestatic

Convert a RequestMode enumeration value to string.

Parameters
mRequestMode to convert
Returns
String representation of RequestMode

Definition at line 142 of file RoutingPacket.hh.


The documentation for this struct was generated from the following file: