ZMQConfirmedInput Class Reference

Input part of a confirmed connection. More...

#include <ZMQConfirmedConnection.h>

Inheritance diagram for ZMQConfirmedInput:

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
	ZMQConfirmedInput (const std::string &inputAddress, const std::shared_ptr< ZMQParent > &parent)
	Create a new confirmed output by binding to the address.
std::unique_ptr< ZMQIdMessage >	handleIncomingData ()
	Block until a message can be received from one of the inputs.
void	clear ()
	Reset the counters for all received stop and terminate messages. Should be called on run start.
std::unique_ptr< ZMQIdMessage >	overwriteStopMessage ()
	Manually overwrite the stop message counter and set it to have all stop messages received.
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
std::set< std::string >	m_receivedStopMessages
	The set of input identities which have already sent a stop message.
bool	m_allStopMessages = false
	Have we received all stop messages?
std::set< std::string >	m_receivedTerminateMessages
	The set of input identities which have already sent a terminate message.
bool	m_allTerminateMessages = false
	Have we received all terminante messages?
std::set< std::string >	m_registeredWorkersInput
	The set of all registered inputs.
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

Input part of a confirmed connection.

In a confirmed connection every message sent by the input to the output is confirmed by a confirmation message by the output. The output can handle multiple inputs, each input can only be connected to a single output.

The input part keeps track of the registered workers and if it has received all stop and/or terminate messages. Stop/Terminate messages are only passed on if received from all registered workers.

If the input receives a message from one of the outputs, it sends back a confirmation message. Depending on the message type, it does several things:

• if the message is a hello message (the input registered itself), it adds the input identity to the registered workers. Nothing is returned to the caller in this case.
• if the message is a delete message (someone unregistered a worker), it removes the specified input identity in the message from the registered workers. Nothing is returned to the caller in this case. (corner case: if it turns out the worker to be unregistered was the last one missing for a full stop or terminate message from all workers, this message is passed on)
• if the message is a stop message, add it to the received stop messages. Only if all registered workers have send a stop message pass it on.
• same for terminate messages
• in all other cases just pass on the message.

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

Definition at line 55 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

ZMQConfirmedInput()

ZMQConfirmedInput	(	const std::string &	inputAddress,
		const std::shared_ptr< ZMQParent > &	parent
	)

Create a new confirmed output by binding to the address.

Definition at line 17 of file ZMQConfirmedConnection.cc.

  : ZMQConnectionOverSocket(parent)
{
  // These are all the log output we will have, set to 0 in the beginning.
  log("last_received_message", "");
  log("total_number_messages", 0l);
  log("registered_workers",  0l);
  log("hello_messages",  0l);
  log("dead_workers",  0l);
  log("all_stop_messages", 0l);
  log("sent_stop_messages",  0l);
  log("last_stop_sent",  "");
  log("received_stop_messages", 0l);
  log("all_terminate_messages", 0l);
  log("sent_terminate_messages",  0l);
  log("last_terminate_sent",  "");
  log("received_terminate_messages", 0l);
  log("received_messages_after_stop", 0l);
  log("last_received_event_message", "");
  log("last_clear", "");
  log("stop_overwrites", 0l);
  log("last_stop_overwrite", "");
 
  log("data_size", 0.0);
  log("received_events", 0l);
  log("event_rate", 0.0);
 
  // Create a binding socket of router type
  m_socket = m_parent->createSocket<ZMQ_ROUTER>(inputAddress, true);
}

Member Function Documentation

clear()

void clear

(

)

Reset the counters for all received stop and terminate messages. Should be called on run start.

Definition at line 171 of file ZMQConfirmedConnection.cc.

{
  // We clear all our internal state and counters
  m_receivedStopMessages.clear();
  m_allStopMessages = false;
  m_receivedTerminateMessages.clear();
  m_allTerminateMessages = false;
 
  log("received_stop_messages", static_cast<long>(m_receivedStopMessages.size()));
  log("all_stop_messages", static_cast<long>(m_allStopMessages));
  log("received_terminate_messages", static_cast<long>(m_receivedTerminateMessages.size()));
  log("all_terminate_messages", static_cast<long>(m_allTerminateMessages));
 
  logTime("last_clear");
}

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()};
}

handleIncomingData()

std::unique_ptr< ZMQIdMessage > handleIncomingData

(

)

Block until a message can be received from one of the inputs.

React as described in the general description of this class. Only if a message is to be passed on actually returns a message (in all other cases a nullptr).

Definition at line 48 of file ZMQConfirmedConnection.cc.

{
  auto message = ZMQMessageFactory::fromSocket<ZMQIdMessage>(m_socket);
  const auto fromIdentity = message->getIdentity();
 
  logTime("last_received_message");
  increment("total_number_messages");
  increment("total_number_messages_from[" + fromIdentity + "]");
 
  auto confirmMessage = ZMQMessageFactory::createMessage(fromIdentity, EMessageTypes::c_confirmMessage);
  ZMQParent::send(m_socket, std::move(confirmMessage));
 
  if (message->isMessage(EMessageTypes::c_helloMessage)) {
    // a hello message makes us register the worker identity - which is the identity of the sender of the message
    m_registeredWorkersInput.emplace(fromIdentity);
    log("registered_workers", static_cast<long>(m_registeredWorkersInput.size()));
    increment("hello_messages");
    increment("hello_messages_from[" + fromIdentity + "]");
    return {};
  } else if (message->isMessage(EMessageTypes::c_deleteWorkerMessage)) {
    // a delete message makes us forget about the worker identity. The identity is taken from the message data
    // making it possible to delete other workers.
    B2DEBUG(30, "Got message from " << message->getIdentity() << " to kill " << message->getMessagePartAsString<2>());
    const std::string& killedIdentity = message->getMessagePartAsString<2>();
    m_registeredWorkersInput.erase(killedIdentity);
 
    log("registered_workers", static_cast<long>(m_registeredWorkersInput.size()));
    increment("dead_workers");
    increment("dead_worker_messaged_from[" + fromIdentity + "]");
 
    if (m_registeredWorkersInput.empty()) {
      B2ERROR("There is not a single worker registered anymore!");
      return {};
    }
 
    // Corner case: could be that this was the one we were waiting for
    if (not m_allStopMessages and m_receivedStopMessages == m_registeredWorkersInput) {
      m_allStopMessages = true;
      log("all_stop_messages", static_cast<long>(m_allStopMessages));
      increment("sent_stop_messages");
      logTime("last_stop_sent");
 
      return ZMQMessageFactory::createMessage(killedIdentity, EMessageTypes::c_lastEventMessage);
    }
    // Corner case: could be that this was the one we were waiting for
    if (not m_allTerminateMessages and m_receivedTerminateMessages == m_registeredWorkersInput) {
      m_allTerminateMessages = true;
      log("all_terminate_messages", static_cast<long>(m_allTerminateMessages));
      increment("sent_terminate_messages");
      logTime("last_terminate_sent");
 
      return ZMQMessageFactory::createMessage(killedIdentity, EMessageTypes::c_terminateMessage);
    }
 
    return {};
  }
 
  B2ASSERT("Worker without proper registration!",
           m_registeredWorkersInput.find(fromIdentity) != m_registeredWorkersInput.end());
 
  if (message->isMessage(EMessageTypes::c_lastEventMessage)) {
    // Increment the stop messages
    m_receivedStopMessages.emplace(fromIdentity);
    log("received_stop_messages", static_cast<long>(m_receivedStopMessages.size()));
    increment("total_received_stop_messages");
 
    if (not m_allStopMessages and m_receivedStopMessages == m_registeredWorkersInput) {
      // But only return this if everyone has sent a stop message already
      m_allStopMessages = true;
      log("all_stop_messages", static_cast<long>(m_allStopMessages));
      increment("sent_stop_messages");
      logTime("last_stop_sent");
 
      return ZMQMessageFactory::createMessage(fromIdentity, EMessageTypes::c_lastEventMessage);
    }
 
    // Whatever we return here will be carried on to the application and eventually also to the output.
    // This means as we are not passing the stop message now, we return nothing.
    return {};
  } else if (message->isMessage(EMessageTypes::c_terminateMessage)) {
    // Increment the terminate messages
    m_receivedTerminateMessages.emplace(fromIdentity);
    log("received_terminate_messages", static_cast<long>(m_receivedTerminateMessages.size()));
    increment("total_received_terminate_messages");
 
    if (not m_allTerminateMessages and m_receivedTerminateMessages == m_registeredWorkersInput) {
      // But only return this if everyone has sent a terminate message already
      m_allTerminateMessages = true;
      log("all_terminate_messages", static_cast<long>(m_allTerminateMessages));
      increment("sent_terminate_messages");
      logTime("last_terminate_sent");
 
      return ZMQMessageFactory::createMessage(fromIdentity, EMessageTypes::c_terminateMessage);
    }
 
    // Whatever we return here will be carried on to the application and eventually also to the output.
    // This means as we are not passing the stop message now, we return nothing.
    return {};
  }
 
  if (m_allStopMessages) {
    B2ERROR("Received an event after having received stop messages from every worker. This is not a good sign! I will dismiss this event!");
    increment("received_messages_after_stop");
    return {};
  }
 
  // Now it can only be a plain normal data message, so just pass it on
  const auto dataSize = message->getDataMessage().size();
 
  average("data_size", dataSize);
  average("data_size_from[" + fromIdentity + "]", dataSize);
 
  increment("received_events");
  increment("received_events[" + fromIdentity + "]");
 
  timeit("event_rate");
  timeit<200>("event_rate_from[" + fromIdentity + "]");
 
  logTime("last_received_event_message");
 
  return message;
}

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));
}

overwriteStopMessage()

std::unique_ptr< ZMQIdMessage > overwriteStopMessage

(

)

Manually overwrite the stop message counter and set it to have all stop messages received.

Definition at line 187 of file ZMQConfirmedConnection.cc.

{
  if (not m_allStopMessages) {
    // We did not already receive all stop messages, but someone externally asked us to stop anyways. So lets do it.
    B2ERROR("Sending out a stop message although not all of the workers are finished already!");
    increment("stop_overwrites");
    logTime("last_stop_overwrite");
 
    m_allStopMessages = true;
    log("all_stop_messages", static_cast<long>(m_allStopMessages));
    increment("sent_stop_messages");
    logTime("last_stop_sent");
 
    return ZMQMessageFactory::createMessage("", EMessageTypes::c_lastEventMessage);
  }
 
  // We have already stopped, no need to sent it twice.
  return {};
}

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_allStopMessages

bool m_allStopMessages = false

private

Have we received all stop messages?

Definition at line 78 of file ZMQConfirmedConnection.h.

m_allTerminateMessages

bool m_allTerminateMessages = false

private

Have we received all terminante messages?

Definition at line 82 of file ZMQConfirmedConnection.h.

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_receivedStopMessages

std::set<std::string> m_receivedStopMessages

private

The set of input identities which have already sent a stop message.

Definition at line 76 of file ZMQConfirmedConnection.h.

m_receivedTerminateMessages

std::set<std::string> m_receivedTerminateMessages

private

The set of input identities which have already sent a terminate message.

Definition at line 80 of file ZMQConfirmedConnection.h.

m_registeredWorkersInput

std::set<std::string> m_registeredWorkersInput

private

The set of all registered inputs.

Definition at line 84 of file ZMQConfirmedConnection.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.

---

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