ZMQROIOutput Class Reference

Dedicated output to send ROI messages to the PXD ONSEN system. More...

#include <ZMQROIConnection.h>

Inheritance diagram for ZMQROIOutput:

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
	ZMQROIOutput (const std::string &outputAddress, const std::shared_ptr< ZMQParent > &parent)
	Create a new ROI output basically initializing the raw output member.
void	handleEvent (zmq::message_t message)
	Send a message and add the PXD specific header and trailer.
std::string	getMonitoringJSON () const final
	Copy the functionality from the raw output.
void	handleIncomingData ()
	Copy the functionality from the raw output.
bool	isReady () const final
	Copy the functionality from the raw output.
std::vector< zmq::socket_t * >	getSockets () const final
	Copy the functionality from the raw output.
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 Member Functions
void	addHeader (char *buffer, unsigned int size)
	Helper function to add the header with the given message size.
void	addTrailer (char *buffer)
	Helper function to add the trailer.

Private Attributes
ZMQRawOutput	m_rawOutput
	The used raw output.
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.

Static Private Attributes
static constexpr const unsigned int	HEADER_SIZE = sizeof(struct h2m_header_t)
	Size of the header in bytes.
static constexpr const unsigned int	TRAILER_SIZE = sizeof(struct h2m_footer_t)
	Size of the trailer in bytes.

Detailed Description

Dedicated output to send ROI messages to the PXD ONSEN system.

Behaves exactly the same as a RawOutput (it is implemented with one) but adds the PXD-specific headers and trailers around the message when sending.

Definition at line 30 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.

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 46 of file ZMQROIConnection.h.

{ return m_rawOutput.getEndPoint(); }

getMonitoringJSON()

std::string getMonitoringJSON ( ) const

finalvirtual

Copy the functionality from the raw output.

Reimplemented from ZMQLogger.

getSockets()

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

finalvirtual

Copy the functionality from the raw output.

Implements ZMQConnection.

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

Copy the functionality from the raw output.

Reimplemented from ZMQConnection.

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

HEADER_SIZE

constexpr const unsigned int HEADER_SIZE = sizeof(struct h2m_header_t)

staticconstexprprivate

Size of the header in bytes.

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

ZMQRawOutput m_rawOutput

private

The used raw output.

Definition at line 54 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.

TRAILER_SIZE

constexpr const unsigned int TRAILER_SIZE = sizeof(struct h2m_footer_t)

staticconstexprprivate

Size of the trailer in bytes.

Definition at line 51 of file ZMQROIConnection.h.

---

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

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