ZMQRawInput Class Reference

Input connection allowing to speak with non-zmq sockets via a ZMQ_STREAM socket. More...

#include <ZMQRawConnection.h>

Inheritance diagram for ZMQRawInput:

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
	ZMQRawInput (const std::string &inputAddress, unsigned int maximalBufferSize, bool receiveEventMessages, const std::shared_ptr< ZMQParent > &parent)
	Create a new raw input connection. The bind or connect behavior is chosen according to the given address.
std::vector< zmq::message_t >	handleIncomingData ()
	Block until a TCP packet can be received from the socket.
void	clear ()
	Reset the internal buffer and counter.
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_maximalBufferSize
	Parameter for the maximal buffer size. If this size is reached, a FATAL will be issued.
std::vector< char >	m_buffer
	Internal storage for the buffer.
size_t	m_writeAddress = 0
	Where in the buffer are we currently writing to.
unsigned int	m_currentSize = 0
	How large should the full message be? The information is from the first int of the message.
bool	m_receiveEventMessages
	Parameter to receive event messages (see above)
std::string	m_inputIdentity = ""
	Internal storage of the connected socket to check if we get messages from multiple ones.
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 connection allowing to speak with non-zmq sockets via a ZMQ_STREAM socket.

Can only speak with a single socket.

On receiving a TC packet, it is stored in an internal buffer. Only if the message is complete it is returned wrapped up as a zmq:message_t.

Two message formats are understood:

• if receiveEventMessages is set to false, the first int of the message must be the size L of the message, in units of sizeof(int) = words. (so full message size in bytes = L * sizeof(int)) Please note that this size also includes this first int, so the real data message has a size in bytes of L * sizeof(int) - sizeof(int)
• if it is true, the first int of the message must be the ntohl-converted size of the message in bytes without this first size int.

The two message formats are chosen to be compatible with the HLT implementation.

Definition at line 41 of file ZMQRawConnection.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

ZMQRawInput()

ZMQRawInput	(	const std::string &	inputAddress,
		unsigned int	maximalBufferSize,
		bool	receiveEventMessages,
		const std::shared_ptr< ZMQParent > &	parent
	)

Create a new raw input connection. The bind or connect behavior is chosen according to the given address.

Definition at line 16 of file ZMQRawConnection.cc.

                                                                 : ZMQConnectionOverSocket(parent),
  m_maximalBufferSize(maximalBufferSize),
  m_receiveEventMessages(receiveEventMessages)
{
  // We clear all our internal state and counters
  log("data_size", 0.0);
  log("received_events", 0l);
  log("event_rate", 0.0);
  log("average_received_byte_packages", 0.0);
 
  log("socket_state", "disconnected");
  log("socket_connects", 0l);
  log("socket_disconnects", 0l);
  log("current_size", 0l);
  log("write_address", 0l);
  log("average_number_of_events_per_package", 0l);
 
  // STREAM is the ZMQ type for raw, non ZMQ connections
  m_socket = m_parent->createSocket<ZMQ_STREAM>(inputAddress);
 
  m_buffer.reserve(maximalBufferSize);
}

Member Function Documentation

clear()

void clear

(

)

Reset the internal buffer and counter.

Definition at line 40 of file ZMQRawConnection.cc.

{
  m_writeAddress = 0;
  m_currentSize = 0;
}

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::vector< zmq::message_t > handleIncomingData

(

)

Block until a TCP packet can be received from the socket.

Returns only full messages as zmq:message_t. Please note that this can be

• 0 messages if there has not been a full message so far
• 1 message if there was
• more than 1 if the message size is smaller than the TCP package size (~8kB)

Definition at line 46 of file ZMQRawConnection.cc.

{
  std::vector<zmq::message_t> receivedMessages;
 
  // We will always get one or two parts. The first one is the identity..
  zmq::message_t identity;
  auto received = m_socket->recv(identity, zmq::recv_flags::none);
  B2ASSERT("No message received", received);
  B2ASSERT("Message should not be empty", *received > 0);
  std::string identityString(identity.data<char>(), identity.size());
  B2ASSERT("The message is incomplete!", m_socket->get(zmq::sockopt::rcvmore) == 1);
  B2ASSERT("The app can only handle a single connection!",
           m_inputIdentity == identityString or m_inputIdentity.empty());
 
  // ... and the second one is the message itself.
  const size_t remainingSpace = m_maximalBufferSize - m_writeAddress;
  auto receivedBytes = m_socket->recv(zmq::mutable_buffer{&m_buffer[m_writeAddress], remainingSpace}, zmq::recv_flags::none);
  B2ASSERT("No message received", receivedBytes);
  B2ASSERT("The message is longer than expected! Increase the buffer size.", !receivedBytes->truncated());
  if (receivedBytes->size == 0) {
    // Empty message means the client connected or disconnected
    if (m_inputIdentity.empty()) {
      m_inputIdentity = identityString;
      log("socket_state", "connected");
      increment("socket_connects");
    } else {
      m_inputIdentity = "";
      log("socket_state", "disconnected");
      increment("socket_disconnects");
    }
    return receivedMessages;
  }
  // We can maximal write `remainingSpace` into the buffer. If the message was longer, ZMQ will just cut it.
  // This means we are loosing data and the buffer size should be increased.
  if (receivedBytes->untruncated_size > remainingSpace) {
    B2FATAL("The size of the buffer is too small! " << receivedBytes->untruncated_size << " > " << remainingSpace);
  }
  average("average_received_byte_packages", receivedBytes->size);
 
  // `m_writeAddress` always points to the index on where we will write next.
  // As we have written `receivedBytes` we need to advance
  m_writeAddress += receivedBytes->size;
 
  log("write_address", static_cast<long>(m_writeAddress));
 
  // If the current buffer is smaller than an int, we can not get the size
  while (m_writeAddress >= sizeof(int)) {
    if (m_currentSize == 0) {
      // we do not know the size of the data package already, so lets get it from the buffer.
      // It is always in the first sizeof(int) of the data
      memcpy(&m_currentSize, &m_buffer[0], sizeof(int));
 
      // Here the two different message formats differ
      if (m_receiveEventMessages) {
        m_currentSize = ntohl(m_currentSize);
      }
      B2ASSERT("Strange size in the data!", m_currentSize > 0);
      if (m_receiveEventMessages) {
        m_currentSize += sizeof(int);
      } else {
        m_currentSize *= sizeof(int);
      }
 
      log("current_size", static_cast<long>(m_currentSize));
    }
    if (m_writeAddress >= m_currentSize) {
      // Now we know the size already, and we have enough data received so we have actually the full
      // data. We can build the total message.
      average("data_size", m_currentSize);
      increment("received_events");
      timeit("event_rate");
 
      // Again, here the two different message formats differ. One includes the first int with the length...
      unsigned int startAddress = 0;
      if (m_receiveEventMessages) {
        // .. and the other does not
        startAddress = sizeof(int);
      }
      zmq::message_t dataMessage(&m_buffer[startAddress], static_cast<size_t>(m_currentSize - startAddress));
 
      memmove(&m_buffer[0], &m_buffer[m_currentSize], m_writeAddress - m_currentSize);
      m_writeAddress -= m_currentSize;
      m_currentSize = 0;
 
      log("write_address", static_cast<long>(m_writeAddress));
      log("current_size", static_cast<long>(m_currentSize));
 
      receivedMessages.push_back(std::move(dataMessage));
    } else {
      // We did not receive a full message up to now
      break;
    }
  }
 
  average("average_number_of_events_per_package", receivedMessages.size());
  return receivedMessages;
}

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_buffer

std::vector<char> m_buffer

private

Internal storage for the buffer.

Definition at line 63 of file ZMQRawConnection.h.

m_currentSize

unsigned int m_currentSize = 0

private

How large should the full message be? The information is from the first int of the message.

Definition at line 67 of file ZMQRawConnection.h.

m_inputIdentity

std::string m_inputIdentity = ""

private

Internal storage of the connected socket to check if we get messages from multiple ones.

Definition at line 71 of file ZMQRawConnection.h.

m_maximalBufferSize

unsigned int m_maximalBufferSize

private

Parameter for the maximal buffer size. If this size is reached, a FATAL will be issued.

Definition at line 61 of file ZMQRawConnection.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_receiveEventMessages

bool m_receiveEventMessages

private

Parameter to receive event messages (see above)

Definition at line 69 of file ZMQRawConnection.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_writeAddress

size_t m_writeAddress = 0

private

Where in the buffer are we currently writing to.

Definition at line 65 of file ZMQRawConnection.h.

---

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