$treeview $search $mathjax $extrastylesheet
artdaq  v3_04_01
$projectbrief
$projectbrief
$searchbox

artdaq::detail::RequestMessage Class Reference

A RequestMessage consists of a RequestHeader and zero or more RequestPackets. They will usually be sent in two calls to send(). More...

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

List of all members.

Public Member Functions

 RequestMessage ()
 Default Constructor.
std::vector< uint8_t > GetMessage ()
 Get the contents of the RequestMessage.
void setMode (RequestMessageMode mode)
 Set the Request Message Mode for this request.
void setRank (int rank)
 Set the rank in the header for this request. This will be the rank from which the request originates.
void setRunNumber (int run)
 Set the run number in the header for this request. This will be the Run for which the request is valid.
size_t size () const
 Get the number of RequestPackets in the RequestMessage.
void addRequest (const Fragment::sequence_id_t &seq, const Fragment::timestamp_t &time)
 Add a request for a sequence ID and timestamp combination.

Detailed Description

A RequestMessage consists of a RequestHeader and zero or more RequestPackets. They will usually be sent in two calls to send().

Definition at line 117 of file RequestMessage.hh.


Member Function Documentation

void artdaq::detail::RequestMessage::addRequest ( const Fragment::sequence_id_t &  seq,
const Fragment::timestamp_t &  time 
) [inline]

Add a request for a sequence ID and timestamp combination.

Parameters:
seq Sequence ID to request
time Timestamp of request

Definition at line 182 of file RequestMessage.hh.

std::vector<uint8_t> artdaq::detail::RequestMessage::GetMessage (  )  [inline]

Get the contents of the RequestMessage.

Returns:
Vector of bytes corresponding to the full RequestMessage (may span multiple packets)

Definition at line 131 of file RequestMessage.hh.

void artdaq::detail::RequestMessage::setMode ( RequestMessageMode  mode  )  [inline]

Set the Request Message Mode for this request.

Parameters:
mode Mode for this Request Message

Definition at line 147 of file RequestMessage.hh.

void artdaq::detail::RequestMessage::setRank ( int  rank  )  [inline]

Set the rank in the header for this request. This will be the rank from which the request originates.

Parameters:
rank Rank for this Request Message

Definition at line 156 of file RequestMessage.hh.

void artdaq::detail::RequestMessage::setRunNumber ( int  run  )  [inline]

Set the run number in the header for this request. This will be the Run for which the request is valid.

Parameters:
run Run number for this Request Message

Definition at line 166 of file RequestMessage.hh.

size_t artdaq::detail::RequestMessage::size (  )  const [inline]

Get the number of RequestPackets in the RequestMessage.

Returns:
The number of RequestPackets in the RequestMessage

Definition at line 175 of file RequestMessage.hh.


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

Generated on 28 Mar 2019 for artdaq by  doxygen 1.6.1