Belle II Software  release-08-01-10
ZMQModuleMessage< AMessageFrameNumber > Class Template Reference

A general message with as many parts as given as template argument. More...

#include <ZMQModuleMessage.h>

Collaboration diagram for ZMQModuleMessage< AMessageFrameNumber >:

Public Types

using MessageParts = std::array< zmq::message_t, ZMQModuleMessage::c_messageParts >
 The base class of the message parts.
 

Public Member Functions

 ZMQModuleMessage (const ZMQModuleMessage &)=delete
 Do not allow to copy a message.
 
void operator= (const ZMQModuleMessage &)=delete
 Do not allow to copy a message.
 
MessagePartsgetMessageParts ()
 Get a reference to the message parts.
 
const MessagePartsgetMessageParts () const
 Get a const reference to the message parts.
 
template<unsigned int index>
const zmq::message_t & getMessagePart () const
 Get the message part with the given index (const version)
 
template<unsigned int index>
const char * getMessagePartAsCharArray () const
 Get the message part with the given index as char* (const version)
 
template<unsigned int index>
std::string getMessagePartAsString () const
 Get the message part with the given index as string (const version)
 
template<unsigned int index>
zmq::message_t & getMessagePart ()
 Get the message part with the given index.
 
template<unsigned int index>
char * getMessagePartAsCharArray ()
 Get the message part with the given index as char*.
 

Static Public Member Functions

static void toSocket (std::unique_ptr< ZMQModuleMessage > message, const std::unique_ptr< zmq::socket_t > &socket)
 Send the message to the given socket. As the message is nullified, you have to move it in here.
 

Static Public Attributes

static constexpr unsigned int c_messageParts = AMessageFrameNumber
 The number of message parts this message carries.
 

Protected Member Functions

 ZMQModuleMessage ()=default
 Do not allow to create a new message from scratch publicly.
 
template<class ... T>
 ZMQModuleMessage (T &&... arguments)
 Constructor out of different parts.
 

Private Attributes

MessageParts m_messageParts
 The content of this message as an array of zmq messages. Will be set during constructor or when coming from a socket.
 

Friends

class ZMQMessageFactory
 

Detailed Description

template<unsigned int AMessageFrameNumber>
class Belle2::ZMQModuleMessage< AMessageFrameNumber >

A general message with as many parts as given as template argument.

Definition at line 24 of file ZMQModuleMessage.h.


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