ZMQRawOutput Class Reference

Output connection to speak to non-zmq sockets via a ZMQ_STREAM socket. More...

#include <ZMQRawConnection.h>

Inheritance diagram for ZMQRawOutput:

Collaboration diagram for ZMQRawOutput:

Public Types
using	ReactorFunction = std::function< void(void)>
	Typedef of a function which will be called if a connection has a message.

Public Member Functions
	ZMQRawOutput (const std::string &outputAddress, bool addEventSize, const std::shared_ptr< ZMQParent > &parent)
	Create a new raw output connection. The bind or connect behavior is chosen according to the given address.
virtual void	handleEvent (zmq::message_t message)
	Pass on the message - maybe by prefixing it with a htonl-converted data size in bytes.
void	handleIncomingData ()
	Handle incoming data: a socket (dis)connect.
bool	isReady () const final
	If no socket is connected, this connection is not ready.
std::vector< zmq::socket_t * >	getSockets () const final
	The socket used for polling is just the stored socket.
std::string	getEndPoint () const
	Return the connection string for this socket.
virtual std::string	getMonitoringJSON () const
	Convert the stored monitoring values to a JSON string ready for sending out via a message.
template<class AClass >
void	log (const std::string &key, const AClass &value)
	Store a value under a certain key. Different types of values can be stored, namely long, double or string. Mixtures are not allowed for a given key.
void	increment (const std::string &key)
	Increment the value with the given key (only numerical values). If not present, set to 1.
void	decrement (const std::string &key)
	Decrement the value with the given key (only numerical values). If not present, set to -1.
template<size_t MAX_SIZE = 100>
void	average (const std::string &key, double value)
	Instead of storeing the double value directly under the given key, store the average of the last MAX_SIZE values.
template<size_t AVERAGE_SIZE = 2000>
void	timeit (const std::string &key)
	Measure the rate of calls with the same key every AVERAGE_SIZE calls (and also display the last time AVERAGE_SIZE was reached under <key>_last_measurement)
void	logTime (const std::string &key)
	Store the current time as a string under the given key.

Static Public Member Functions
static bool	poll (const std::map< const ZMQConnection *, ReactorFunction > &connectionList, int timeout)
	Poll on the given connections and call the attached function if a messages comes in. More...
static bool	hasMessage (const ZMQConnection *connection)
	Check if the given connection as an incoming message (right now, no waiting).

Protected Attributes
std::shared_ptr< ZMQParent >	m_parent
	The shared ZMQParent instance.
std::unique_ptr< zmq::socket_t >	m_socket
	The memory of the socket. Needs to be initialized in a derived class.

Private Attributes
std::string	m_dataIdentity = ""
	Internal storage of the connected identity to no have multiple connections.
bool	m_addEventSize = false
	Parameter to add the event size to a message.
std::map< std::string, std::variant< long, double, std::string > >	m_monitoring
	Internal storage of all stored values.
std::unordered_map< std::string, std::tuple< std::vector< double >, size_t > >	m_averages
	Internal storage of the previous values when calculating averages.
std::unordered_map< std::string, std::tuple< unsigned long, std::chrono::system_clock::time_point > >	m_timeCounters
	Internal storage how often the timeit function for a given key was called and when it has last reached MAX_SIZE.

Detailed Description

Output connection to speak to non-zmq sockets via a ZMQ_STREAM socket.

If a socket is connected, sends out the given message over this socket as it is. If addEventSize is true, will prefix the message with the htonl-converted size of the message in bytes. Compare this to the receiveEventMessages setting of the ZMQRawInput connection. If no socket is connected, this connection is not ready.

Please note that although it is an output connection, there will still be "incoming messages", namely whenever the socket connects or disconnects. So you need to poll on this connection. Can only send messages to a single connected socket.

Definition at line 87 of file ZMQRawConnection.h.

Member Function Documentation

poll()

bool poll ( const std::map< const ZMQConnection *, ReactorFunction > &  connectionList, int  timeout  )

staticinherited

Poll on the given connections and call the attached function if a messages comes in.

If after timeout milliseconds still no message is received, return anyways. If timeout is 0, do not wait. If timeout is -1, wait infinitely.

Returns true if a message was received on any socket, false otherwise. Attention: in case of an interrupted system call (e.g. because a signal was received) the function might return anyways with a negative result even before the timeout!

Definition at line 27 of file ZMQConnection.cc.

---

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

• framework/pcore/zmq/connections/include/ZMQRawConnection.h
• framework/pcore/zmq/connections/src/ZMQRawConnection.cc