ZeroMQ Class Reference

#include <ZeroMQ.hpp>

Inheritance diagram for ZeroMQ:

Public Member Functions
	ZeroMQ (const zmq::socket_type &type, const std::string &addr, bool isBind)
	ZeroMQ (const std::shared_ptr< zmq::context_t > &ctx, const zmq::socket_type &type, const std::string &addr, bool isBind)
	ZeroMQ (const ZeroMQ &)=delete
	Copy constructor.
	ZeroMQ (ZeroMQ &&)=delete
	Move constructor.
ZeroMQ &	operator= (ZeroMQ)=delete
	Copy assignment operator.
ZeroMQ &	operator= (ZeroMQ &&)=delete
	Move assignment operator.
bool	start ()
void	stop ()
std::vector< zmq::message_t >	recvMessages ()
size_t	sendMessages (std::vector< zmq::message_t > &msg)
const std::unique_ptr< zmq::socket_t > &	getSocket () const
const std::shared_ptr< zmq::context_t > &	getContext () const
const std::string &	getAddress () const
	~ZeroMQ ()

Private Member Functions
void	init (const std::shared_ptr< zmq::context_t > &ctx, const zmq::socket_type &type, const std::string_view &addr, bool isBind)

Private Attributes
std::shared_ptr< zmq::context_t >	_contextPtr
std::unique_ptr< zmq::socket_t >	_socketPtr
bool	_isActive {false}
bool	_isBinded {false}
std::string	_socketAddr

Detailed Description

A class that provides a wrapper for ZeroMQ functionality.

This class encapsulates the ZeroMQ library and provides methods to initialize, start, stop, send, and receive messages using ZeroMQ sockets. It supports both binding and connecting to sockets and provides a convenient interface for working with multipart messages.

Definition at line 13 of file ZeroMQ.hpp.

Constructor & Destructor Documentation

ZeroMQ() [1/4]

ZeroMQ::ZeroMQ	(	const zmq::socket_type &	type,
		const std::string &	addr,
		bool	isBind )

Construct a new ZeroMQ class

Parameters

[in]	type	Type of the socket
[in]	addr	Full socket address
[in]	isBind	True if should be binded, false if should be connected

Definition at line 32 of file ZeroMQ.cpp.

{
    init(std::make_shared<zmq::context_t>(1), type, addr, isBind);
}

Here is the call graph for this function:

ZeroMQ() [2/4]

ZeroMQ::ZeroMQ	(	const std::shared_ptr< zmq::context_t > &	ctx,
		const zmq::socket_type &	type,
		const std::string &	addr,
		bool	isBind )

Construct a new ZeroMQ class

Parameters

[in]	ctx	ZeroMQ context
[in]	type	Type of the socket
[in]	addr	Full socket address
[in]	isBind	True if should be binded, false if should be connected

Definition at line 37 of file ZeroMQ.cpp.

{
    init(ctx, type, addr, isBind);
}

Here is the call graph for this function:

ZeroMQ() [3/4]

ZeroMQ::ZeroMQ ( const ZeroMQ & )

delete

Copy constructor.

ZeroMQ() [4/4]

ZeroMQ::ZeroMQ ( ZeroMQ && )

delete

Move constructor.

~ZeroMQ()

ZeroMQ::~ZeroMQ

(

)

Destroy the ZeroMQ class

Definition at line 111 of file ZeroMQ.cpp.

{
    try
    {
        stop();
    }
    catch (const std::exception &e)
    {
        try
        {
            spdlog::error("Error while stopping ZeroMQ connection {} ({})", _socketAddr, e.what());
        }
        catch (const std::exception &e2)
        {
            std::cerr << "Error while stopping ZeroMQ connection and logger for connection " << _socketAddr << " ("
                      << e.what() << ")" << '\n'
                      << e2.what() << '\n';
        }
    }
}

Here is the call graph for this function:

Member Function Documentation

getAddress()

const std::string & ZeroMQ::getAddress ( ) const

inlinenodiscard

Get the address of the socket

Returns

const std::string& Address of the socket

Definition at line 102 of file ZeroMQ.hpp.

{ return _socketAddr; }

getContext()

const std::shared_ptr< zmq::context_t > & ZeroMQ::getContext ( ) const

inlinenodiscard

Get the reference of context

Returns

const std::shared_ptr<zmq::context_t>&

Definition at line 96 of file ZeroMQ.hpp.

{ return _contextPtr; }

getSocket()

const std::unique_ptr< zmq::socket_t > & ZeroMQ::getSocket ( ) const

inlinenodiscard

Get the reference of socket

Returns

const std::unique_ptr<zmq::socket_t>&

Definition at line 90 of file ZeroMQ.hpp.

{ return _socketPtr; }

Here is the caller graph for this function:

init()

void ZeroMQ::init ( const std::shared_ptr< zmq::context_t > & ctx, const zmq::socket_type & type, const std::string_view & addr, bool isBind )

private

Definition at line 14 of file ZeroMQ.cpp.

{
    _contextPtr = ctx;
    _socketAddr = addr;
    _isBinded = isBind;
    _isActive = false;
 
    // Init ZMQ connection
    _socketPtr = std::make_unique<zmq::socket_t>(*_contextPtr, type);
    _socketPtr->set(zmq::sockopt::linger, 0);
    _socketPtr->set(zmq::sockopt::sndtimeo, ZEROMQ_MSG_TIMEOUT_MS);
    _socketPtr->set(zmq::sockopt::rcvtimeo, ZEROMQ_MSG_TIMEOUT_MS);
    _socketPtr->set(zmq::sockopt::heartbeat_ivl, ZEROMQ_HEARTBEAT_TIMEOUT_MS);
    _socketPtr->set(zmq::sockopt::heartbeat_ttl, ZEROMQ_HEARTBEAT_TIMEOUT_MS * 3);
    _socketPtr->set(zmq::sockopt::heartbeat_timeout, ZEROMQ_HEARTBEAT_TIMEOUT_MS);
}

Here is the caller graph for this function:

operator=() [1/2]

ZeroMQ & ZeroMQ::operator= ( ZeroMQ && )

delete

Move assignment operator.

operator=() [2/2]

ZeroMQ & ZeroMQ::operator= ( ZeroMQ )

delete

Copy assignment operator.

recvMessages()

std::vector< zmq::message_t > ZeroMQ::recvMessages

(

)

Receives multipart message

Returns

std::vector<zmq::message_t> Received messages

Definition at line 81 of file ZeroMQ.cpp.

{
    std::vector<zmq::message_t> recvMsgs;
    if (!_isActive)
    {
        spdlog::warn("Connection needs to starting");
    }
    else
    {
        auto nMsgs = zmq::recv_multipart(*_socketPtr, std::back_inserter(recvMsgs));
        spdlog::debug("Received {} messages", nMsgs.value_or(0));
    }
    return recvMsgs;
}

Here is the caller graph for this function:

sendMessages()

size_t ZeroMQ::sendMessages

(

std::vector< zmq::message_t > &

msg

)

Sends multipart message

Parameters

[in]

msg

Messages to send

Returns

size_t Number of sent messages

Definition at line 96 of file ZeroMQ.cpp.

{
    zmq::send_result_t res;
    if (!_isActive)
    {
        spdlog::warn("Connection needs to starting");
    }
    else
    {
        res = zmq::send_multipart(*_socketPtr, msg);
    }
 
    return res.value_or(0);
}

Here is the caller graph for this function:

start()

bool ZeroMQ::start

(

)

Starts the connection

Returns

True if successfully initialized

Definition at line 43 of file ZeroMQ.cpp.

{
    if (_isActive)
    {
        return false;
    }
 
    if (_isBinded)
    {
        _socketPtr->bind(_socketAddr);
    }
    else
    {
        _socketPtr->connect(_socketAddr);
    }
    _isActive = true;
 
    return true;
}

Here is the caller graph for this function:

stop()

void ZeroMQ::stop

(

)

Stops the connection

Definition at line 63 of file ZeroMQ.cpp.

{
    if (!_isActive)
    {
        return;
    }
 
    if (_isBinded)
    {
        _socketPtr->unbind(_socketAddr);
    }
    else
    {
        _socketPtr->disconnect(_socketAddr);
    }
    _isActive = false;
}

Here is the caller graph for this function:

Member Data Documentation

_contextPtr

std::shared_ptr<zmq::context_t> ZeroMQ::_contextPtr

private

Definition at line 16 of file ZeroMQ.hpp.

_isActive

bool ZeroMQ::_isActive {false}

private

Definition at line 21 of file ZeroMQ.hpp.

{false};

_isBinded

bool ZeroMQ::_isBinded {false}

private

Definition at line 23 of file ZeroMQ.hpp.

{false};

_socketAddr

std::string ZeroMQ::_socketAddr

private

Definition at line 25 of file ZeroMQ.hpp.

_socketPtr

std::unique_ptr<zmq::socket_t> ZeroMQ::_socketPtr

private

Definition at line 18 of file ZeroMQ.hpp.

---

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

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