Belle II Software  release-08-01-10
ZMQIdMessage Class Reference

A message with the socket ID. Needed in input<->worker communication. More...

#include <ZMQIdMessage.h>

Inheritance diagram for ZMQIdMessage:
Collaboration diagram for ZMQIdMessage:

Public Types

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

Public Member Functions

bool isMessage (const EMessageTypes isType) const
 The if the message is of a given type.
 
std::string getIdentity () const
 Get the identity part.
 
zmq::message_t & getDataMessage ()
 Get the data part.
 
zmq::message_t & getAdditionalDataMessage ()
 Get the additional data part.
 
MessagePartsgetMessageParts ()
 Get a reference to the message parts.
 
const MessagePartsgetMessageParts () const
 Get a const reference to the message parts.
 
const zmq::message_t & getMessagePart () const
 Get the message part with the given index (const version)
 
zmq::message_t & getMessagePart ()
 Get the message part with the given index.
 
const char * getMessagePartAsCharArray () const
 Get the message part with the given index as char* (const version)
 
char * getMessagePartAsCharArray ()
 Get the message part with the given index as char*.
 
std::string getMessagePartAsString () const
 Get the message part with the given index as string (const version)
 

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 const unsigned int c_identity = 0
 Where the identity is stored.
 
static constexpr const unsigned int c_type = 1
 Where the type of the message is stored.
 
static constexpr const unsigned int c_data = 2
 Where the data is stored.
 
static constexpr const unsigned int c_additionalData = 3
 Where the additional data is stored.
 
static constexpr unsigned int c_messageParts
 The number of message parts this message carries.
 

Private Member Functions

 ZMQModuleMessage (const ZMQModuleMessage &)=delete
 Copy the constructor from the base class.
 
 ZMQModuleMessage ()=default
 Copy the constructor from the base class.
 
template<class ... T>
 ZMQModuleMessage (T &&... arguments)
 Copy the constructor from the base class.
 

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

A message with the socket ID. Needed in input<->worker communication.

Definition at line 21 of file ZMQIdMessage.h.


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