ZeroMQMonitor Class Reference

#include <ZeroMQMonitor.hpp>

Inheritance diagram for ZeroMQMonitor:

Collaboration diagram for ZeroMQMonitor:

Public Member Functions
	ZeroMQMonitor ()=default
	Constructor.
	ZeroMQMonitor (const ZeroMQMonitor &)=delete
	Copy constructor.
	ZeroMQMonitor (ZeroMQMonitor &&)=delete
	Move constructor.
ZeroMQMonitor &	operator= (ZeroMQMonitor)=delete
	Copy assignment operator.
ZeroMQMonitor &	operator= (ZeroMQMonitor &&)=delete
	Move assignment operator.
void	startMonitoring (zmq::socket_t *socket, const std::string &monitorAddress)
int	getPeerCount () const
void	stopMonitoring ()
void	testInternals ()
	~ZeroMQMonitor () override

Private Member Functions
void	threadFunc ()
void	on_monitor_started () override
void	on_event_connected (const zmq_event_t &, const char *addr_) override
void	on_event_connect_delayed (const zmq_event_t &, const char *addr_) override
void	on_event_connect_retried (const zmq_event_t &, const char *addr_) override
void	on_event_listening (const zmq_event_t &, const char *addr_) override
void	on_event_bind_failed (const zmq_event_t &, const char *addr_) override
void	on_event_accepted (const zmq_event_t &, const char *addr_) override
void	on_event_accept_failed (const zmq_event_t &, const char *addr_) override
void	on_event_closed (const zmq_event_t &, const char *addr_) override
void	on_event_close_failed (const zmq_event_t &, const char *addr_) override
void	on_event_disconnected (const zmq_event_t &, const char *addr_) override
void	on_event_handshake_failed_no_detail (const zmq_event_t &, const char *addr_) override
void	on_event_handshake_failed_protocol (const zmq_event_t &, const char *addr_) override
void	on_event_handshake_failed_auth (const zmq_event_t &, const char *addr_) override
void	on_event_handshake_succeeded (const zmq_event_t &, const char *addr_) override
void	on_event_unknown (const zmq_event_t &, const char *addr_) override

Static Private Member Functions
static void	on_event (const std::string &messageStr, int level, const char *addr=nullptr)

Private Attributes
std::unique_ptr< std::thread >	_monitorThread
std::atomic_flag	_shouldStop {false}
std::atomic_int	_peerCount {0}

Detailed Description

Class for monitoring ZeroMQ events on a socket.

The ZeroMQMonitor class provides functionality to monitor ZeroMQ events on a socket. It starts a separate thread to listen for events and invokes corresponding event handlers. The class supports various event types such as connection, binding, acceptance, closure, etc.

Definition at line 17 of file ZeroMQMonitor.hpp.

Constructor & Destructor Documentation

ZeroMQMonitor() [1/3]

ZeroMQMonitor::ZeroMQMonitor ( )

default

Constructor.

ZeroMQMonitor() [2/3]

ZeroMQMonitor::ZeroMQMonitor ( const ZeroMQMonitor & )

delete

Copy constructor.

ZeroMQMonitor() [3/3]

ZeroMQMonitor::ZeroMQMonitor ( ZeroMQMonitor && )

delete

Move constructor.

~ZeroMQMonitor()

ZeroMQMonitor::~ZeroMQMonitor ( )

inlineoverride

Destructor.

Definition at line 113 of file ZeroMQMonitor.hpp.

{ stopMonitoring(); }

Here is the call graph for this function:

Member Function Documentation

getPeerCount()

int ZeroMQMonitor::getPeerCount ( ) const

inlinenodiscard

Get the number of peers connected.

Returns

Number of peers connected.

Definition at line 98 of file ZeroMQMonitor.hpp.

{ return _peerCount; }

on_event()

void ZeroMQMonitor::on_event ( const std::string & messageStr, int level, const char * addr = nullptr )

staticprivate

Definition at line 15 of file ZeroMQMonitor.cpp.

{
    switch (level)
    {
    case spdlog::level::debug:
        spdlog::debug("{} {}", messageStr, addr == nullptr ? "" : addr);
        break;
    case spdlog::level::info:
        spdlog::info("{} {}", messageStr, addr == nullptr ? "" : addr);
        break;
    case spdlog::level::warn:
        spdlog::warn("{} {}", messageStr, addr == nullptr ? "" : addr);
        break;
    default:
        break;
    }
}

Here is the caller graph for this function:

on_event_accept_failed()

void ZeroMQMonitor::on_event_accept_failed ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 66 of file ZeroMQMonitor.cpp.

{
    on_event("Accept failed", spdlog::level::warn, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_accepted()

void ZeroMQMonitor::on_event_accepted ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 61 of file ZeroMQMonitor.cpp.

{
    on_event("Accepted", spdlog::level::info, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_bind_failed()

void ZeroMQMonitor::on_event_bind_failed ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 56 of file ZeroMQMonitor.cpp.

{
    on_event("Bind failed", spdlog::level::warn, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_close_failed()

void ZeroMQMonitor::on_event_close_failed ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 76 of file ZeroMQMonitor.cpp.

{
    on_event("Close failed", spdlog::level::warn, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_closed()

void ZeroMQMonitor::on_event_closed ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 71 of file ZeroMQMonitor.cpp.

{
    on_event("Closed", spdlog::level::debug, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_connect_delayed()

void ZeroMQMonitor::on_event_connect_delayed ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 41 of file ZeroMQMonitor.cpp.

{
    on_event("Connect delayed", spdlog::level::debug, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_connect_retried()

void ZeroMQMonitor::on_event_connect_retried ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 46 of file ZeroMQMonitor.cpp.

{
    on_event("Connect retried", spdlog::level::debug, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_connected()

void ZeroMQMonitor::on_event_connected ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 35 of file ZeroMQMonitor.cpp.

{
    _peerCount.fetch_add(1);
    on_event("Connected", spdlog::level::info, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_disconnected()

void ZeroMQMonitor::on_event_disconnected ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 81 of file ZeroMQMonitor.cpp.

{
    _peerCount.fetch_sub(1);
    on_event("Disconnected", spdlog::level::info, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_handshake_failed_auth()

void ZeroMQMonitor::on_event_handshake_failed_auth ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 99 of file ZeroMQMonitor.cpp.

{
    on_event("Handshake failed (auth)", spdlog::level::warn, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_handshake_failed_no_detail()

void ZeroMQMonitor::on_event_handshake_failed_no_detail ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 89 of file ZeroMQMonitor.cpp.

{
    on_event("Handshake failed (no detail)", spdlog::level::warn, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_handshake_failed_protocol()

void ZeroMQMonitor::on_event_handshake_failed_protocol ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 94 of file ZeroMQMonitor.cpp.

{
    on_event("Handshake failed (protocol)", spdlog::level::warn, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_handshake_succeeded()

void ZeroMQMonitor::on_event_handshake_succeeded ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 104 of file ZeroMQMonitor.cpp.

{
    on_event("Handshake succeeded", spdlog::level::info, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_listening()

void ZeroMQMonitor::on_event_listening ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 51 of file ZeroMQMonitor.cpp.

{
    on_event("Listening", spdlog::level::debug, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_event_unknown()

void ZeroMQMonitor::on_event_unknown ( const zmq_event_t & , const char * addr_ )

overrideprivate

Definition at line 121 of file ZeroMQMonitor.cpp.

{
    on_event("Unknown event", spdlog::level::warn, addr_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

on_monitor_started()

void ZeroMQMonitor::on_monitor_started ( )

overrideprivate

Definition at line 33 of file ZeroMQMonitor.cpp.

{ on_event("Monitor started", spdlog::level::info); }

Here is the call graph for this function:

operator=() [1/2]

ZeroMQMonitor & ZeroMQMonitor::operator= ( ZeroMQMonitor && )

delete

Move assignment operator.

operator=() [2/2]

ZeroMQMonitor & ZeroMQMonitor::operator= ( ZeroMQMonitor )

delete

Copy assignment operator.

startMonitoring()

void ZeroMQMonitor::startMonitoring	(	zmq::socket_t *	socket,
		const std::string &	monitorAddress )

Start monitoring events on the given socket.

This method starts a separate thread to listen for events on the given socket. The method also sets up the event handlers for various event types.

Parameters

[in]	socket	Zeromq socket
[in]	monitorAddress	Monitoring address

Definition at line 126 of file ZeroMQMonitor.cpp.

{
    if (socket == nullptr)
    {
        throw std::invalid_argument("ZeroMQ socket to monitor is nullptr");
    }
 
    init(*socket, monitorAddress);
    _monitorThread = std::make_unique<std::thread>(&ZeroMQMonitor::threadFunc, this);
}

Here is the call graph for this function:

Here is the caller graph for this function:

stopMonitoring()

void ZeroMQMonitor::stopMonitoring

(

)

Stop monitoring events on the socket.

Definition at line 168 of file ZeroMQMonitor.cpp.

{
    _shouldStop.test_and_set();
#ifdef ZMQ_EVENT_MONITOR_STOPPED
    abort();
#endif
 
    // Join the thread
    if (_monitorThread && _monitorThread->joinable())
    {
        _monitorThread->join();
        _monitorThread.reset();
    }
 
    spdlog::info("Monitor stopped");
}

Here is the caller graph for this function:

testInternals()

void ZeroMQMonitor::testInternals

(

)

Test internals of the ZeroMQMonitor class.

Definition at line 137 of file ZeroMQMonitor.cpp.

{
    const std::vector<std::function<void()>> testFunctions = {
        [this]() { on_event_connected(zmq_event_t{}, "test_address"); },
        [this]() { on_event_connect_delayed(zmq_event_t{}, "test_address"); },
        [this]() { on_event_connect_retried(zmq_event_t{}, "test_address"); },
        [this]() { on_event_listening(zmq_event_t{}, "test_address"); },
        [this]() { on_event_bind_failed(zmq_event_t{}, "test_address"); },
        [this]() { on_event_accepted(zmq_event_t{}, "test_address"); },
        [this]() { on_event_accept_failed(zmq_event_t{}, "test_address"); },
        [this]() { on_event_closed(zmq_event_t{}, "test_address"); },
        [this]() { on_event_close_failed(zmq_event_t{}, "test_address"); },
        [this]() { on_event_disconnected(zmq_event_t{}, "test_address"); },
#if ZMQ_VERSION >= ZMQ_MAKE_VERSION(4, 3, 0) ||                                                                        \
    (defined(ZMQ_BUILD_DRAFT_API) && ZMQ_VERSION >= ZMQ_MAKE_VERSION(4, 2, 3))
        [this]() { on_event_handshake_failed_no_detail(zmq_event_t{}, "test_address"); },
        [this]() { on_event_handshake_failed_protocol(zmq_event_t{}, "test_address"); },
        [this]() { on_event_handshake_failed_auth(zmq_event_t{}, "test_address"); },
        [this]() { on_event_handshake_succeeded(zmq_event_t{}, "test_address"); },
#elif defined(ZMQ_BUILD_DRAFT_API) && ZMQ_VERSION >= ZMQ_MAKE_VERSION(4, 2, 1)
        [this]() { on_event_handshake_failed(zmq_event_t{}, "test_address"); },
        [this]() { on_event_handshake_succeed(zmq_event_t{}, "test_address"); },
#endif
        [this]() { on_event_unknown(zmq_event_t{}, "test_address"); }};
 
    for (const auto &testFunc : testFunctions)
    {
        testFunc();
    }
}

Here is the call graph for this function:

threadFunc()

void ZeroMQMonitor::threadFunc ( )

private

Definition at line 7 of file ZeroMQMonitor.cpp.

{
    while (!_shouldStop._M_i)
    {
        check_event(EVENT_CHECK_TIMEOUT_MS);
    }
}

Here is the caller graph for this function:

Member Data Documentation

_monitorThread

std::unique_ptr<std::thread> ZeroMQMonitor::_monitorThread

private

Thread for monitoring events.

Definition at line 19 of file ZeroMQMonitor.hpp.

_peerCount

std::atomic_int ZeroMQMonitor::_peerCount {0}

private

Number of peers connected.

Definition at line 21 of file ZeroMQMonitor.hpp.

{0};                 

_shouldStop

std::atomic_flag ZeroMQMonitor::_shouldStop {false}

private

Flag to stop monitoring.

Definition at line 20 of file ZeroMQMonitor.hpp.

{false};         

---

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

• /__w/Repo-Init/Repo-Init/include/zeromq/ZeroMQMonitor.hpp
• /__w/Repo-Init/Repo-Init/src/zeromq/ZeroMQMonitor.cpp