ZMQDataAndROIOutput Class Reference

Helper connection hosting both a normal raw and a ROI output and sending to both at the same time. More...

#include <ZMQROIConnection.h>

Inheritance diagram for ZMQDataAndROIOutput:

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
	ZMQDataAndROIOutput (const std::string &dataAddress, const std::string &roiAddress, bool addEventSize, const std::shared_ptr< ZMQParent > &parent)
	Initialize the raw and roi connection.
std::string	getMonitoringJSON () const final
	Get the monitoring JSON from the raw connection.
std::string	getROIMonitoringJSON () const
	Get the monitoring JSON from the ROI connection.
void	handleEvent (std::unique_ptr< ZMQNoIdMessage > message)
	Send the normal data message to raw and the additional message to ROI.
void	handleIncomingData ()
	Handle both a socket (dis)connect by raw or ROI.
bool	isReady () const final
	Ready only when both sockets are ready.
std::vector< zmq::socket_t * >	getSockets () const final
	Return both sockets for polling.
std::string	getEndPoint () const
	Return the connection string.
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).

Private Attributes
ZMQRawOutput	m_dataOutput
	The used raw connection.
ZMQRawOutput	m_roiOutput
	The used ROI connection.
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

Helper connection hosting both a normal raw and a ROI output and sending to both at the same time.

The normal message will be sent to the raw connection whereas the additional message will be sent to the roi connection.

As two connections are hosted also two monitoring JSON can be requested.

Definition at line 70 of file ZMQROIConnection.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

ZMQDataAndROIOutput()

ZMQDataAndROIOutput	(	const std::string &	dataAddress,
		const std::string &	roiAddress,
		bool	addEventSize,
		const std::shared_ptr< ZMQParent > &	parent
	)

Initialize the raw and roi connection.

Definition at line 13 of file ZMQROIConnection.cc.

                                                                                                    :
  m_dataOutput(dataAddress, addEventSize, parent), m_roiOutput(roiAddress, false, parent) {}

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

inline

Return the connection string.

Definition at line 90 of file ZMQROIConnection.h.

{ return m_dataOutput.getEndPoint() + ";" + m_roiOutput.getEndPoint(); }

getMonitoringJSON()

std::string getMonitoringJSON ( ) const

finalvirtual

Get the monitoring JSON from the raw connection.

Reimplemented from ZMQLogger.

Definition at line 48 of file ZMQROIConnection.cc.

{
  return m_dataOutput.getMonitoringJSON();
}

getROIMonitoringJSON()

std::string getROIMonitoringJSON

(

)

const

Get the monitoring JSON from the ROI connection.

Definition at line 53 of file ZMQROIConnection.cc.

{
  return m_roiOutput.getMonitoringJSON();
}

getSockets()

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

finalvirtual

Return both sockets for polling.

Implements ZMQConnection.

Definition at line 43 of file ZMQROIConnection.cc.

{
  return {m_dataOutput.getSockets()[0], m_roiOutput.getSockets()[0]};
}

handleEvent()

void handleEvent

(

std::unique_ptr< ZMQNoIdMessage >

message

)

Send the normal data message to raw and the additional message to ROI.

Definition at line 17 of file ZMQROIConnection.cc.

{
  if (message->isMessage(EMessageTypes::c_rawDataMessage) or message->isMessage(EMessageTypes::c_eventMessage)) {
    B2ASSERT("The data message needs to be present!", message->getDataMessage().size() > 0);
    B2ASSERT("The roi message needs to be present!", message->getAdditionalDataMessage().size() > 0);
 
    m_dataOutput.handleEvent(std::move(message->getDataMessage()));
    m_roiOutput.handleEvent(std::move(message->getAdditionalDataMessage()));
  }
}

handleIncomingData()

void handleIncomingData

(

)

Handle both a socket (dis)connect by raw or ROI.

Definition at line 28 of file ZMQROIConnection.cc.

{
  if (ZMQConnection::hasMessage(&m_dataOutput)) {
    m_dataOutput.handleIncomingData();
  }
  if (ZMQConnection::hasMessage(&m_roiOutput)) {
    m_roiOutput.handleIncomingData();
  }
}

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

Ready only when both sockets are ready.

Reimplemented from ZMQConnection.

Definition at line 38 of file ZMQROIConnection.cc.

{
  return m_dataOutput.isReady() and m_roiOutput.isReady();
}

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_dataOutput

ZMQRawOutput m_dataOutput

private

The used raw connection.

Definition at line 93 of file ZMQROIConnection.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_roiOutput

ZMQRawOutput m_roiOutput

private

The used ROI connection.

Definition at line 95 of file ZMQROIConnection.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:

• daq/hbasf2/connections/include/ZMQROIConnection.h
• daq/hbasf2/connections/src/ZMQROIConnection.cc