artdaq  v3_01_00
artdaq::detail Namespace Reference

The artdaq::detail namespace contains internal implementation details for some classes. More...

Classes

struct  SharedMemoryReader
 The SharedMemoryReader is a class which implements the methods needed by art::Source. More...
 
class  FragCounter
 Keep track of the count of Fragments received from a set of sources. More...
 
struct  RequestPacket
 The RequestPacket contains information about a single data request. More...
 
struct  RequestHeader
 Header of a RequestMessage. Contains magic bytes for validation and a count of expected RequestPackets. More...
 
class  RequestMessage
 A RequestMessage consists of a RequestHeader and zero or more RequestPackets. They will usually be sent in two calls to send() More...
 
struct  RoutingPacketEntry
 A row of the Routing Table. More...
 
struct  RoutingPacketHeader
 The header of the Routing Table, containing the magic bytes and the number of entries. More...
 
struct  RoutingAckPacket
 A RoutingAckPacket contains the rank of the table receiver, plus the first and last sequence IDs in the Routing Table (for verification) More...
 
struct  RoutingToken
 The RoutingToken contains the magic bytes, the rank of the token sender, and the number of slots free. This is a TCP message, so additional verification is not necessary. More...
 

Typedefs

using RoutingPacket = std::vector< RoutingPacketEntry >
 A RoutingPacket is simply a vector of RoutingPacketEntry objects. It is not suitable for network transmission, rather a RoutingPacketHeader should be sent, followed by &RoutingPacket.at(0) (the physical storage of the vector)
 

Enumerations

enum  TaskType : int {
  BoardReaderTask = 1, EventBuilderTask = 2, DataLoggerTask = 3, DispatcherTask = 4,
  RoutingMasterTask = 5, UnknownTask
}
 The types of applications in artdaq.
 
enum  RequestMessageMode : uint8_t { RequestMessageMode::Normal = 0, RequestMessageMode::EndOfRun = 1 }
 Mode used to indicate current run conditions to the request receiver. More...
 
enum  RoutingMasterMode : uint8_t { RoutingMasterMode::RouteBySequenceID, RoutingMasterMode::RouteBySendCount, INVALID }
 Mode indicating whether the RoutingMaster is routing events by Sequence ID or by Send Count. More...
 

Functions

TaskType StringToTaskType (std::string task)
 
TaskType IntToTaskType (int task)
 
std::string TaskTypeToString (TaskType task)
 
std::ostream & operator<< (std::ostream &o, RequestMessageMode m)
 Converts the RequestMessageMode to a string and sends it to the output stream. More...
 

Detailed Description

The artdaq::detail namespace contains internal implementation details for some classes.

Enumeration Type Documentation

enum artdaq::detail::RequestMessageMode : uint8_t
strong

Mode used to indicate current run conditions to the request receiver.

Enumerator
Normal 

Normal running.

EndOfRun 

End of Run mode (Used to end request processing on receiver)

Definition at line 17 of file RequestMessage.hh.

enum artdaq::detail::RoutingMasterMode : uint8_t
strong

Mode indicating whether the RoutingMaster is routing events by Sequence ID or by Send Count.

Enumerator
RouteBySequenceID 

Events should be routed by sequence ID (BR -> EB)

RouteBySendCount 

Events should be routed by send count (EB -> Agg)

Definition at line 24 of file RoutingPacket.hh.

Function Documentation

std::ostream& artdaq::detail::operator<< ( std::ostream &  o,
RequestMessageMode  m 
)
inline

Converts the RequestMessageMode to a string and sends it to the output stream.

Parameters
oStream to send string to
mRequestMessageMode to convert to string
Returns
o with string sent to it

Definition at line 29 of file RequestMessage.hh.