ZMQLoadBalancedOutput Class Reference

Output part of a load-balanced connection. More...

#include <ZMQLoadBalancedConnection.h>

Inheritance diagram for ZMQLoadBalancedOutput:

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
	ZMQLoadBalancedOutput (const std::string &outputAddress, bool lax, const std::shared_ptr< ZMQParent > &parent)
	Create a new load-balanced output and bind to the given address.
void	handleEvent (std::unique_ptr< ZMQNoIdMessage > message)
	Send the given message (without identity) to the next input in the ready list.
void	handleIncomingData ()
	Block until a ready message from an input is received and add it to the ready queue.
void	clear ()
	Clear the counter for sent stop and terminate messages. Should be called on run start.
bool	isReady () const final
	If lax mode is disabled, the output is ready if at least a single input is ready. Else always.
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.
static bool	hasMessage (const ZMQConnection *connection)
	Check if the given connection as an incoming message (right now, no waiting).

Protected Attributes
std::deque< std::string >	m_readyWorkers
	List of identities of ready inputs in LIFO order.
std::set< std::string >	m_allWorkers
	All ever registered inputs.
bool	m_sentStopMessages = false
	Did we already sent a stop message?
bool	m_sentTerminateMessages = false
	Did we already sent a terminate message?
bool	m_lax = false
	Parameter to enable lax mode.
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::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 load-balanced connection.

Multiple inputs can connect to this output. The output keeps a list of all received ready messages and sends events on requests always to the next input in the list, which creates some sort of load-balancing.

Stop and terminate messages are sent all all inputs that have sent at least a single ready so far. There is no unregistration happening, so dead inputs will still be served with both events and stop/terminate messages. For stop/terminate messages this is no problem and event messages will only be sent as long as there are ready messages.

After a stop message is sent all additional incoming events will be dismissed.

If no input has send any ready message, the output is not ready and needs to be polled for new ready messages. However, there is also a "lax" mode which makes the events being silently discarded if no input is ready.

Internally a ZMQ_ROUTER in bind mode is used.

Definition at line 71 of file ZMQLoadBalancedConnection.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

ZMQLoadBalancedOutput()

ZMQLoadBalancedOutput	(	const std::string &	outputAddress,
		bool	lax,
		const std::shared_ptr< ZMQParent > &	parent
	)

Create a new load-balanced output and bind to the given address.

Definition at line 56 of file ZMQLoadBalancedConnection.cc.

                                                                                     : ZMQConnectionOverSocket(
                                                 parent), m_lax(lax)
{
  // We clear all our internal state and counters
  log("ready_queue_size", static_cast<long>(m_readyWorkers.size()));
  log("registered_workers", static_cast<long>(m_allWorkers.size()));
 
  log("data_size", 0.0);
  log("dismissed_events", 0l);
  log("event_rate", 0.0);
  log("sent_events", 0l);
 
  log("all_stop_messages", 0l);
  log("sent_stop_messages",  0l);
  log("last_stop_sent",  "");
 
  log("all_terminate_messages", 0l);
  log("sent_terminate_messages",  0l);
  log("last_terminate_sent",  "");
 
  // Create a binding ROUTER socket
  m_socket = m_parent->createSocket<ZMQ_ROUTER>(outputAddress, true);
}

Member Function Documentation

clear()

void clear

(

)

Clear the counter for sent stop and terminate messages. Should be called on run start.

Definition at line 169 of file ZMQLoadBalancedConnection.cc.

{
  m_sentStopMessages = false;
  m_sentTerminateMessages = false;
 
  log("all_stop_messages", static_cast<long>(m_sentStopMessages));
  log("all_terminate_messages", static_cast<long>(m_sentTerminateMessages));
}

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

)

Send the given message (without identity) to the next input in the ready list.

If it is a stop or terminate message send the message to all inputs which have ever sent a ready message. If it is an event message, sent it only to the next ready input. If there is no ready input it either (a) throws and exception if lax mode is not enabled. Make sure to only sent events if the output is ready (which indicates exactly this: an input is ready). Or (b) discard the event without warning if lax mode is enabled.

Definition at line 81 of file ZMQLoadBalancedConnection.cc.

{
  if (message->isMessage(EMessageTypes::c_lastEventMessage)) {
    // Tell all workers to stop this run
    for (auto worker : m_allWorkers) {
      auto sendMessage = ZMQMessageFactory::createMessage(worker, EMessageTypes::c_lastEventMessage);
      ZMQParent::send(m_socket, std::move(sendMessage));
    }
    m_sentStopMessages = true;
    log("all_stop_messages", static_cast<long>(m_sentStopMessages));
    increment("sent_stop_messages");
    logTime("last_stop_sent");
    return;
  } else if (message->isMessage(EMessageTypes::c_terminateMessage)) {
    // Tell all workers to terminate
    for (auto worker : m_allWorkers) {
      auto sendMessage = ZMQMessageFactory::createMessage(worker, EMessageTypes::c_terminateMessage);
      ZMQParent::send(m_socket, std::move(sendMessage));
    }
    m_sentTerminateMessages = true;
    log("all_terminate_messages", static_cast<long>(m_sentTerminateMessages));
    increment("sent_terminate_messages");
    logTime("last_terminate_sent");
    return;
  }
 
  if (m_lax and m_readyWorkers.empty()) {
    // There is no one that can handle the event in the moment, dismiss it (if lax is true)
    increment("dismissed_events");
    return;
  }
  if (m_sentStopMessages) {
    B2ERROR("Received events after stop! I will dismiss this event.");
    increment("dismissed_events");
    return;
  }
 
  const auto dataSize = message->getDataMessage().size();
 
  B2ASSERT("Must be > 0", not m_readyWorkers.empty());
  auto nextWorker = m_readyWorkers.front();
  m_readyWorkers.pop_front();
 
  average("data_size", dataSize);
  average("data_size_to[" + nextWorker + "]", dataSize);
 
  increment("sent_events");
  increment("sent_events[" + nextWorker + "]");
 
  timeit("event_rate");
  timeit<200>("event_rate_to[" + nextWorker + "]");
 
  m_socket->send(ZMQMessageHelper::createZMQMessage(nextWorker), zmq::send_flags::sndmore);
  ZMQParent::send(m_socket, std::move(message));
 
  log("ready_queue_size", static_cast<long>(m_readyWorkers.size()));
  decrement("ready_messages[" + nextWorker + "]");
}

handleIncomingData()

void handleIncomingData

(

)

Block until a ready message from an input is received and add it to the ready queue.

Definition at line 140 of file ZMQLoadBalancedConnection.cc.

{
  auto readyMessage = ZMQMessageFactory::fromSocket<ZMQIdMessage>(m_socket);
  B2ASSERT("Should be a ready message", readyMessage->isMessage(EMessageTypes::c_readyMessage));
 
  // Register it as another ready worker
  const auto toIdentity = readyMessage->getIdentity();
  m_readyWorkers.push_back(toIdentity);
 
  if (m_allWorkers.emplace(toIdentity).second) {
    // Aha, we did never see this worker so far, so add it to our list.
    if (m_sentStopMessages) {
      // If it turned up late (everyone else has already stopped), send a stop message directly
      auto sendMessage = ZMQMessageFactory::createMessage(toIdentity, EMessageTypes::c_lastEventMessage);
      ZMQParent::send(m_socket, std::move(sendMessage));
    }
 
    if (m_sentTerminateMessages) {
      // If it turned up late (everyone else has already terminates), send a terminate message directly
      auto sendMessage = ZMQMessageFactory::createMessage(toIdentity, EMessageTypes::c_terminateMessage);
      ZMQParent::send(m_socket, std::move(sendMessage));
    }
  }
 
  log("ready_queue_size", static_cast<long>(m_readyWorkers.size()));
  log("registered_workers", static_cast<long>(m_allWorkers.size()));
  increment("ready_messages[" + toIdentity + "]");
}

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

finalvirtual

If lax mode is disabled, the output is ready if at least a single input is ready. Else always.

Reimplemented from ZMQConnection.

Definition at line 178 of file ZMQLoadBalancedConnection.cc.

{
  // if we are lax, we are always ready. If not, we need to have at least a single ready worker. This prevents the B2ASSERT to fail.
  return m_lax or not m_readyWorkers.empty();
}

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_allWorkers

std::set<std::string> m_allWorkers

protected

All ever registered inputs.

Definition at line 101 of file ZMQLoadBalancedConnection.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_lax

bool m_lax = false

protected

Parameter to enable lax mode.

Definition at line 107 of file ZMQLoadBalancedConnection.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_readyWorkers

std::deque<std::string> m_readyWorkers

protected

List of identities of ready inputs in LIFO order.

Definition at line 99 of file ZMQLoadBalancedConnection.h.

m_sentStopMessages

bool m_sentStopMessages = false

protected

Did we already sent a stop message?

Definition at line 103 of file ZMQLoadBalancedConnection.h.

m_sentTerminateMessages

bool m_sentTerminateMessages = false

protected

Did we already sent a terminate message?

Definition at line 105 of file ZMQLoadBalancedConnection.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/ZMQLoadBalancedConnection.h
• framework/pcore/zmq/connections/src/ZMQLoadBalancedConnection.cc