ZMQModuleMessage< AMessageFrameNumber > Class Template Reference

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

#include <ZMQModuleMessage.h>

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.
MessageParts &	getMessageParts ()
	Get a reference to the message parts.
const MessageParts &	getMessageParts () 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.

Member Typedef Documentation

MessageParts

template<unsigned int AMessageFrameNumber>

using MessageParts = std::array<zmq::message_t, ZMQModuleMessage::c_messageParts>

The base class of the message parts.

Definition at line 32 of file ZMQModuleMessage.h.

Constructor & Destructor Documentation

ZMQModuleMessage()

template<unsigned int AMessageFrameNumber>

template<class ... T>

ZMQModuleMessage ( T &&... arguments )

inlineexplicitprotected

Constructor out of different parts.

Definition at line 104 of file ZMQModuleMessage.h.

                                                 :
      m_messageParts({ZMQMessageHelper::createZMQMessage(std::forward<T>(arguments)) ... })
    {
    }

Member Function Documentation

getMessagePart() [1/2]

template<unsigned int AMessageFrameNumber>

template<unsigned int index>

zmq::message_t & getMessagePart ( )

inline

Get the message part with the given index.

Definition at line 85 of file ZMQModuleMessage.h.

    {
      return m_messageParts[index];
    }

getMessagePart() [2/2]

template<unsigned int AMessageFrameNumber>

template<unsigned int index>

const zmq::message_t & getMessagePart ( ) const

inline

Get the message part with the given index (const version)

Definition at line 62 of file ZMQModuleMessage.h.

    {
      return m_messageParts[index];
    }

getMessagePartAsCharArray() [1/2]

template<unsigned int AMessageFrameNumber>

template<unsigned int index>

char * getMessagePartAsCharArray ( )

inline

Get the message part with the given index as char*.

Definition at line 92 of file ZMQModuleMessage.h.

    {
      auto& messagePart = getMessagePart<index>();
      return static_cast<char*>(messagePart.data());
    }

getMessagePartAsCharArray() [2/2]

template<unsigned int AMessageFrameNumber>

template<unsigned int index>

const char * getMessagePartAsCharArray ( ) const

inline

Get the message part with the given index as char* (const version)

Definition at line 69 of file ZMQModuleMessage.h.

    {
      const auto& messagePart = getMessagePart<index>();
      return static_cast<const char*>(messagePart.data());
    }

getMessagePartAsString()

template<unsigned int AMessageFrameNumber>

template<unsigned int index>

std::string getMessagePartAsString ( ) const

inline

Get the message part with the given index as string (const version)

Definition at line 77 of file ZMQModuleMessage.h.

    {
      const auto& messagePart = getMessagePart<index>();
      return std::string(static_cast<const char*>(messagePart.data()), messagePart.size());
    }

getMessageParts() [1/2]

template<unsigned int AMessageFrameNumber>

MessageParts & getMessageParts ( )

inline

Get a reference to the message parts.

Definition at line 49 of file ZMQModuleMessage.h.

    {
      return m_messageParts;
    };

getMessageParts() [2/2]

template<unsigned int AMessageFrameNumber>

const MessageParts & getMessageParts ( ) const

inline

Get a const reference to the message parts.

Definition at line 55 of file ZMQModuleMessage.h.

    {
      return m_messageParts;
    };

toSocket()

template<unsigned int AMessageFrameNumber>

static void toSocket ( std::unique_ptr< ZMQModuleMessage< AMessageFrameNumber > > message, const std::unique_ptr< zmq::socket_t > & socket )

inlinestatic

Send the message to the given socket. As the message is nullified, you have to move it in here.

Definition at line 35 of file ZMQModuleMessage.h.

    {
      for (unsigned int i = 0; i < c_messageParts - 1; i++) {
        socket->send(message->m_messageParts[i], zmq::send_flags::sndmore);
      }
      socket->send(message->m_messageParts[c_messageParts - 1], zmq::send_flags::none);
    }

Friends And Related Symbol Documentation

ZMQMessageFactory

template<unsigned int AMessageFrameNumber>

friend class ZMQMessageFactory

friend

Definition at line 25 of file ZMQModuleMessage.h.

Member Data Documentation

c_messageParts

template<unsigned int AMessageFrameNumber>

unsigned int c_messageParts = AMessageFrameNumber

staticconstexpr

The number of message parts this message carries.

Definition at line 29 of file ZMQModuleMessage.h.

m_messageParts

template<unsigned int AMessageFrameNumber>

MessageParts m_messageParts

private

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

Definition at line 111 of file ZMQModuleMessage.h.

---

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

• framework/pcore/zmq/messages/include/ZMQModuleMessage.h