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...

Enumerations

enum  TaskType {
  BoardReaderTask = 1, EventBuilderTask = 2, DataLoggerTask = 3, DispatcherTask = 4,
  RoutingMasterTask = 5, UnknownTask
}
 

The types of applications in artdaq.


enum  RequestMessageMode { Normal = 0, EndOfRun = 1 }
 

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

More...
enum  RoutingMasterMode { RouteBySequenceID, RouteBySendCount, INVALID }
 

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

More...

Functions

TaskType StringToTaskType (std::string const &task)
 Convert a string to a TaskType (Used by artdaq.cc).
TaskType IntToTaskType (int const &task)
 Convert an integer to the corresponding TaskType.
std::string TaskTypeToString (TaskType const &task)
 Convert a TaskType to string representation.
TraceStreamer & operator<< (TraceStreamer &x, TaskType r)
std::ostream & operator<< (std::ostream &o, RequestMessageMode m)
 Converts the RequestMessageMode to a string and sends it to the output stream.

Detailed Description

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


Enumeration Type Documentation

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 18 of file RequestMessage.hh.

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

TaskType artdaq::detail::IntToTaskType ( int const &  task  ) 

Convert an integer to the corresponding TaskType.

Parameters:
task Enumeration identifier of Task
Returns:
Corresponding TaskType or TaskType::UnknownTask if no match

Definition at line 54 of file TaskType.hh.

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:
o Stream to send string to
m RequestMessageMode to convert to string
Returns:
o with string sent to it

Definition at line 30 of file RequestMessage.hh.

TaskType artdaq::detail::StringToTaskType ( std::string const &  task  ) 

Convert a string to a TaskType (Used by artdaq.cc).

Parameters:
task Name of the task
Returns:
Corresponding TaskType or TaskType::UnknownTask if no match

Definition at line 34 of file TaskType.hh.

std::string artdaq::detail::TaskTypeToString ( TaskType const &  task  ) 

Convert a TaskType to string representation.

Parameters:
task TaskType to convert
Returns:
String represenation of Task name

Definition at line 67 of file TaskType.hh.


Generated on 25 Sep 2018 for artdaq by  doxygen 1.6.1