ZMQConfirmedOutput Class Reference

Output part of a confirmed connection. More...

#include <ZMQConfirmedConnection.h>

Inheritance diagram for ZMQConfirmedOutput:

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
	ZMQConfirmedOutput (const std::string &outputAddress, const std::shared_ptr< ZMQParent > &parent)
	Create a new confirmed output by connecting to the address.
void	handleEvent (std::unique_ptr< ZMQNoIdMessage > message, bool requireConfirmation=true, int maximalWaitTime=10000)
	Send the message to the output (a message without a ID as there is only a single output).
void	handleIncomingData ()
	Blocks until it can receive the (hopefully confirmation) message from the output.
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 bool	isReady () const
	Return true of this connection is able to send messages right now. Can be overloaded in derived classes.
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.
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
unsigned int	m_waitingForConfirmation = 0
	On how many confirmation messages are we still waiting?
long	m_timespanWaitingForConfirmation = 0
	Internal monitoring how long we were waiting for confirmation messages.
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 part of a confirmed connection.

For an introduction to confirmed connections please see the ZMQConfirmedInput.

The confirmed output basically just sends out messages and waits for confirmations. Two additions to that:

• on startup, it sends a single hello message to the output to register itself. This message also needs to be confirmed.
• Instead of waiting for a confirmation after sending the message, the blocking happens before sending the next message. This gives the output some time for reacting without slowing down the output part.

If no confirmation is received on time, either a FATAL is issued or (configurable) only a warning.

Internally, a ZMQ_DEALER socket is used in non-bind mode. The order of starting output and input does not play any role.

Definition at line 106 of file ZMQConfirmedConnection.h.

Member Typedef Documentation

ReactorFunction

using ReactorFunction = std::function<void(void)>

inherited

Typedef of a function which will be called if a connection has a message.

Definition at line 34 of file ZMQConnection.h.

Constructor & Destructor Documentation

ZMQConfirmedOutput()

ZMQConfirmedOutput	(	const std::string &	outputAddress,
		const std::shared_ptr< ZMQParent > &	parent
	)

Create a new confirmed output by connecting to the address.

Definition at line 207 of file ZMQConfirmedConnection.cc.

  : ZMQConnectionOverSocket(parent)
{
  // These are all the log output we will have, set to 0 in the beginning.
  log("no_confirmation_message", 0l);
  log("last_sent_event_message", 0l);
  log("data_size", 0.0);
  log("sent_events", 0l);
  log("event_rate", 0.0);
  log("timespan_waiting_for_confirmation", 0l);
 
  // Register a non-binding DEALER socket
  m_socket = m_parent->createSocket<ZMQ_DEALER>(outputAddress, false);
 
  logTime("last_hello_sent");
 
  // Say hello to the receiver end of the connection (which is a confirmed input)
  auto message = ZMQMessageFactory::createMessage(EMessageTypes::c_helloMessage);
  handleEvent(std::move(message));
}

Member Function Documentation

decrement()

void decrement ( const std::string &  key )

inherited

Decrement the value with the given key (only numerical values). If not present, set to -1.

Definition at line 37 of file ZMQLogger.cc.

{
  std::visit(Decrementor{}, m_monitoring[key]);
}

getEndPoint()

std::string getEndPoint ( ) const

inherited

Return the connection string for this socket.

Definition at line 87 of file ZMQConnection.cc.

{
  std::string endpoint{""};
  if (m_socket) {
    endpoint = m_socket->get(zmq::sockopt::last_endpoint);
  }
  return endpoint;
}

getMonitoringJSON()

std::string getMonitoringJSON ( ) const

virtualinherited

Convert the stored monitoring values to a JSON string ready for sending out via a message.

Reimplemented in ZMQHistoServerToZMQOutput, ZMQHistoServerToRawOutput, ZMQROIOutput, and ZMQDataAndROIOutput.

Definition at line 15 of file ZMQLogger.cc.

{
  std::stringstream buffer;
  buffer << "{";
  bool first = true;
  for (const auto& keyValue : m_monitoring) {
    if (not first) {
      buffer << ", ";
    }
    first = false;
    buffer << "\"" << keyValue.first << "\": ";
    buffer << std::visit(toJSON{}, keyValue.second);
  }
  buffer << "}" << std::endl;
  return buffer.str();
}

getSockets()

std::vector< zmq::socket_t * > getSockets ( ) const

finalvirtualinherited

The socket used for polling is just the stored socket.

Implements ZMQConnection.

Definition at line 82 of file ZMQConnection.cc.

{
  return {m_socket.get()};
}

handleEvent()

void handleEvent	(	std::unique_ptr< ZMQNoIdMessage >	message,
		bool	requireConfirmation = true,
		int	maximalWaitTime = 10000
	)

Send the message to the output (a message without a ID as there is only a single output).

If requireConfirmation is set to true and no confirmation (from the last sent event!) is received before sending the new event, a B2FATAL is issued (in other cases only a warning). Set the maximalWaitTime to -1 to always wait infinitely (not preferred).

Definition at line 228 of file ZMQConfirmedConnection.cc.

{
  auto current = std::chrono::system_clock::now();
  while (m_waitingForConfirmation > 0) {
    // Wait for all conformation messages that are still pending.
    if (ZMQParent::poll({m_socket.get()}, maximalWaitTime)) {
      handleIncomingData();
    } else if (requireConfirmation) {
      B2FATAL("Did not receive a confirmation message in time!");
    } else {
      B2WARNING("Did not receive a confirmation message in time!");
      increment("no_confirmation_message");
      // If we did not receive one, we will also not receive the next one so lets break out.
      break;
    }
  }
  auto afterWaiting = std::chrono::system_clock::now();
  m_timespanWaitingForConfirmation += std::chrono::duration_cast<std::chrono::milliseconds>(afterWaiting - current).count();
  log("timespan_waiting_for_confirmation", m_timespanWaitingForConfirmation);
 
  // We have received a confirmation for the old, so we can also sent a new message.
 
  // TODO: makes no sense for signal messages!
  const auto dataSize = message->getDataMessage().size();
 
  average("data_size", dataSize);
  increment("sent_events");
  timeit("event_rate");
 
  logTime("last_sent_event_message");
 
  ZMQParent::send(m_socket, std::move(message));
  m_waitingForConfirmation++;
}

handleIncomingData()

void handleIncomingData

(

)

Blocks until it can receive the (hopefully confirmation) message from the output.

Can be called even before sending an event to receive the confirmation message ahead of time (e.g. when there is nothing else to do).

Definition at line 263 of file ZMQConfirmedConnection.cc.

{
  // This should only ever be a confirmation message
  B2ASSERT("There should be no data coming here, if we have already a confirmation!", m_waitingForConfirmation > 0);
  auto acceptMessage = ZMQMessageFactory::fromSocket<ZMQNoIdMessage>(m_socket);
  B2ASSERT("Should be an accept message", acceptMessage->isMessage(EMessageTypes::c_confirmMessage));
  m_waitingForConfirmation--;
}

hasMessage()

bool hasMessage ( const ZMQConnection *  connection )

staticinherited

Check if the given connection as an incoming message (right now, no waiting).

Definition at line 20 of file ZMQConnection.cc.

{
  // Just poll with 0 timeout and no reaction function. Hacky trick to reduce code duplication
  const auto emptyFunction = []() {};
  return ZMQConnection::poll({{connection, emptyFunction}}, 0);
}

increment()

void increment ( const std::string &  key )

inherited

Increment the value with the given key (only numerical values). If not present, set to 1.

Definition at line 32 of file ZMQLogger.cc.

{
  std::visit(Incrementor{}, m_monitoring[key]);
}

isReady()

bool isReady ( ) const

virtualinherited

Return true of this connection is able to send messages right now. Can be overloaded in derived classes.

Reimplemented in ZMQROIOutput, ZMQDataAndROIOutput, ZMQLoadBalancedOutput, ZMQRawOutput, ZMQHistoServerToZMQOutput, and ZMQHistoServerToRawOutput.

Definition at line 15 of file ZMQConnection.cc.

{
  return true;
}

logTime()

void logTime ( const std::string &  key )

inherited

Store the current time as a string under the given key.

Definition at line 42 of file ZMQLogger.cc.

{
  auto current = std::chrono::system_clock::now();
  auto displayTime = std::chrono::system_clock::to_time_t(current);
  log(key, std::ctime(&displayTime));
}

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.

{
  std::vector<const ReactorFunction*> socketMapping;
  std::vector<zmq::pollitem_t> pollItems;
 
  // zmq needs a special format for its polling, so create it here.
  for (const auto& [connection, function] : connectionList) {
    auto sockets = connection->getSockets();
    for (zmq::socket_t* socket : sockets) {
      zmq::pollitem_t pollItem;
      pollItem.socket = static_cast<void*>(*socket);
      pollItem.events = ZMQ_POLLIN;
      pollItem.revents = 0;
      pollItems.push_back(std::move(pollItem));
 
      // but keep reference to the original function, so we can call the correct one later
      socketMapping.push_back(&function);
    }
  }
 
  if (pollItems.empty()) {
    return false;
  }
 
  try {
    zmq::poll(&pollItems[0], pollItems.size(), timeout);
 
    bool anySocket = false;
    unsigned int counter = 0;
    for (const auto& pollItem : pollItems) {
      if (pollItem.revents & ZMQ_POLLIN) {
        anySocket = true;
        const auto* functionPtr = socketMapping.at(counter);
        const auto function = *functionPtr;
        function();
      }
      counter++;
    }
 
    return anySocket;
  } catch (zmq::error_t& error) {
    if (error.num() == EINTR) {
      // Could happen if there was an interrupt, return false so the caller knows the time did not pass already
      return false;
    } else {
      // cannot handle, rethrow exception
      throw;
    }
  }
}

Member Data Documentation

m_averages

std::unordered_map<std::string, std::tuple<std::vector<double>, size_t> > m_averages

privateinherited

Internal storage of the previous values when calculating averages.

Definition at line 60 of file ZMQLogger.h.

m_monitoring

std::map<std::string, std::variant<long, double, std::string> > m_monitoring

privateinherited

Internal storage of all stored values.

Definition at line 58 of file ZMQLogger.h.

m_parent

std::shared_ptr<ZMQParent> m_parent

protectedinherited

The shared ZMQParent instance.

Definition at line 75 of file ZMQConnection.h.

m_socket

std::unique_ptr<zmq::socket_t> m_socket

protectedinherited

The memory of the socket. Needs to be initialized in a derived class.

Definition at line 77 of file ZMQConnection.h.

m_timeCounters

std::unordered_map<std::string, std::tuple<unsigned long, std::chrono::system_clock::time_point> > m_timeCounters

privateinherited

Internal storage how often the timeit function for a given key was called and when it has last reached MAX_SIZE.

Definition at line 62 of file ZMQLogger.h.

m_timespanWaitingForConfirmation

long m_timespanWaitingForConfirmation = 0

private

Internal monitoring how long we were waiting for confirmation messages.

Definition at line 130 of file ZMQConfirmedConnection.h.

m_waitingForConfirmation

unsigned int m_waitingForConfirmation = 0

private

On how many confirmation messages are we still waiting?

Definition at line 128 of file ZMQConfirmedConnection.h.

---

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

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