ZmqContext.hpp

Go to the documentation of this file.

#ifndef IPM_INCLUDE_IPM_ZMQCONTEXT_HPP_
#define IPM_INCLUDE_IPM_ZMQCONTEXT_HPP_

 
#include "ers/Issue.hpp"
#include "logging/Logging.hpp" // NOTE: if ISSUES ARE DECLARED BEFORE include logging/Logging.hpp, TLOG_DEBUG<<issue wont work.
#include "zmq.hpp"
 
enum
{
  TLVL_ZMQCONTEXT = 10,
  TLVL_CONNECTIONSTRING = 11,
  TLVL_ZMQPUBLISHER_SEND_START = 12,
  TLVL_ZMQPUBLISHER_SEND_ERR = 2,
  TLVL_ZMQPUBLISHER_SEND_END = 13,
  TLVL_ZMQPUBLISHER_DESTRUCTOR = 5,
  TLVL_ZMQRECEIVER_RECV_HDR = 14,
  TLVL_ZMQRECEIVER_RECV_HDR_2 = 15,
  TLVL_ZMQRECEIVER_RECV_DATA = 16,
  TLVL_ZMQRECEIVER_RECV_DATA_2 = 17,
  TLVL_ZMQRECEIVER_RECV_END = 18,
  TLVL_ZMQSENDER_SEND_START = 19,
  TLVL_ZMQSENDER_SEND_ERR = 3,
  TLVL_ZMQSENDER_SEND_END = 20,
  TLVL_ZMQSENDER_DESTRUCTOR = 5,
  TLVL_ZMQSUBSCRIBER_RECV_HDR = 21,
  TLVL_ZMQSUBSCRIBER_RECV_HDR_2 = 22,
  TLVL_ZMQSUBSCRIBER_RECV_DATA = 23,
  TLVL_ZMQSUBSCRIBER_RECV_DATA_2 = 24,
  TLVL_ZMQSUBSCRIBER_RECV_END = 25,
};
 
namespace dunedaq {

ERS_DECLARE_ISSUE(ipm,
                  ZmqOperationError,
                  connection_name << ": An exception occured while calling " << operation << " on the ZMQ " << direction
                                  << " socket: " << what << " (connection_string: " << connection_string << ")",
                  ((std::string)connection_name)((std::string)operation)((std::string)direction)((const char*)what)(
                    (std::string)connection_string)) // NOLINT

ERS_DECLARE_ISSUE(
  ipm,
  ZmqSendError,
  connection_name << ": An exception occurred while sending " << N << " bytes to " << topic << ": " << what,
  ((std::string)connection_name)((const char*)what)((int)N)((std::string)topic)) // NOLINT

ERS_DECLARE_ISSUE(ipm,
                  ZmqReceiveError,
                  connection_name << ": An exception occured while receiving " << which << ": " << what,
                  ((std::string)connection_name)((const char*)what)((const char*)which)) // NOLINT

ERS_DECLARE_ISSUE(ipm,
                  ZmqSubscribeError,
                  connection_name << ": An execption occured while subscribing to " << topic << ": " << what,
                  ((std::string)connection_name)((const char*)what)((std::string)topic)) // NOLINT

ERS_DECLARE_ISSUE(ipm,
                  ZmqUnsubscribeError,
                  connection_name << ": An execption occured while unsubscribing from " << topic << ": " << what,
                  ((std::string)connection_name)((const char*)what)((std::string)topic)) // NOLINT
 
namespace ipm {
class ZmqContext
{
public:
  static ZmqContext& instance()
  {
    static ZmqContext s_ctx;
    return s_ctx;
  }
 
  zmq::context_t& GetContext() { return m_context; }
 
  void set_context_threads(int nthreads)
  {
    TLOG_DEBUG(TLVL_ZMQCONTEXT) << "Setting ZMQ Context IO thread count to " << nthreads;
    m_context.set(zmq::ctxopt::io_threads, nthreads);
  }
  void set_context_maxsockets(int max_sockets)
  {
    TLOG_DEBUG(TLVL_ZMQCONTEXT) << "Setting ZMQ Context max sockets to " << max_sockets;
    m_context.set(zmq::ctxopt::max_sockets, max_sockets);
  }
 
private:
  ZmqContext()
  {
    auto threads_c = getenv("IPM_ZMQ_IO_THREADS");
    if (threads_c != nullptr) {
      auto threads = std::atoi(threads_c); // NOLINT If a conversion error occurs, we discard the result
      if (threads > 1) {
        set_context_threads(threads);
      }
    }
 
    bool sockets_set = false;
    auto sockets_c = getenv("IPM_ZMQ_MAX_SOCKETS");
    if (sockets_c != nullptr) {
      auto sockets = std::atoi(sockets_c); // NOLINT If a conversion error occurs, we discard the result
      if (sockets > s_minimum_sockets) {
        set_context_maxsockets(sockets);
        sockets_set = true;
      }
    }
    if (!sockets_set) {
      set_context_maxsockets(s_minimum_sockets);
    }
  }
  ~ZmqContext()
  {
    TLOG_DEBUG(TLVL_ZMQCONTEXT) << "Closing ZMQ Context";
    m_context.close();
    TLOG_DEBUG(TLVL_ZMQCONTEXT) << "ZMQ Context closed";
  }
  zmq::context_t m_context;
  static constexpr int s_minimum_sockets = 16636;
 
  ZmqContext(ZmqContext const&) = delete;
  ZmqContext(ZmqContext&&) = delete;
  ZmqContext& operator=(ZmqContext const&) = delete;
  ZmqContext& operator=(ZmqContext&&) = delete;
};
} // namespace ipm
} // namespace dunedaq
 
#endif // IPM_INCLUDE_IPM_ZMQCONTEXT_HPP_