PZmqBackend.h File Reference

#include <string>
#include "PSocketFlag.h"
#include "phoenix_generic_mock.h"
#include "phoenix_data_stream.h"
#include "phoenix_zmq.h"
#include "PZmqBackend_impl.h"

Include dependency graph for PZmqBackend.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	PZmqBackend
	Backend to use Mock library with PAbtractSocket. More...
struct	PZmqParam
	Set of parameters to be passed to create a socket with zmq backend. More...
class	PZmqSocket
	PhoenixSocket API bridge to ZMQ socket. More...

Functions
PRecvStatus::PRecvStatus	checkRecvStatus (zmq::recv_result_t res)
	Check the recv result and convert it into PRecvStatus.
PSendStatus::PSendStatus	checkSendStatus (zmq::send_result_t res)
	Check the send result and convert it into PSendStatus.
PZmqParam	pzmq_createParamClient (int type, int nbBufferMessage=10000, int bufferSizeByte=1000000, size_t threadAffinity=0lu, ssize_t dataRate=200000l)
	Create param for a client socket.
PZmqParam	pzmq_createParamServer (int type, int nbBufferMessage=10000, int bufferSizeByte=1000000, size_t threadAffinity=0lu, ssize_t dataRate=200000l)
	Create param for a client socket.
template<typename T>
std::string	statusToStr (T status)
	Convert PSendStatus into string.

Function Documentation

checkRecvStatus()

PRecvStatus::PRecvStatus checkRecvStatus

(

zmq::recv_result_t

res

)

Check the recv result and convert it into PRecvStatus.

Parameters

res	: result of the zmq recv

Returns

corresponding PRecvStatus

ZMQ socket recv has a bit of a strange implementation:

• if recv works: the recv_result_t has a value
• if recv doesn't work due to EAGAIN error: the recv_result_t is empty (no value) and error should be EAGAIN
• if recv doesn't work for another reason: an exception is thrown This function only checks the behaviour due to the recv result, not the thrown error.

Definition at line 46 of file PZmqBackend.cpp.

                                                            {
    if(res.has_value()){
        return PRecvStatus::OK;
    }
    else{
        int err = zmq_errno();
        if(err == EAGAIN){
            return PRecvStatus::NO_MESSAGE_RECEIVED;
        }
        else{
            return PRecvStatus::BROKEN_SOCKET;
        }
    }
}

Referenced by PZmqSocket::recvMsg().

Here is the caller graph for this function:

checkSendStatus()

PSendStatus::PSendStatus checkSendStatus

(

zmq::send_result_t

res

)

Check the send result and convert it into PSendStatus.

Parameters

res	: result of the zmq send

Returns

corresponding PSendStatus

ZMQ socket send has a bit of a strange implementation:

• if sending works: the send_result_t has a value
• if sending doesn't work due to EAGAIN error: the send_result_t is empty (no value) and error should be EAGAIN
• if sending doesn't work for another reason: an exception is thrown This function only checks the behaviour due to the send result, not the thrown error.

Definition at line 20 of file PZmqBackend.cpp.

                                                            {
    if(res.has_value()){
        return PSendStatus::OK;
    }
    else{
        int err = zmq_errno();
        if(err == EAGAIN){
            return PSendStatus::SOCKET_NOT_AVAILABLE;
        }
        else{
            std::cerr << "Unknown ZMQ error in send: '" <<  err << "'"<< std::endl;
            return PSendStatus::BROKEN_BACKEND;
        }
    }
}

Referenced by PZmqSocket::sendMsg().

Here is the caller graph for this function:

pzmq_createParamClient()

PZmqParam pzmq_createParamClient	(	int	type,
		int	nbBufferMessage,
		int	bufferSizeByte,
		size_t	threadAffinity,
		ssize_t	dataRate )

Create param for a client socket.

Parameters

context	: zmq context where to create socket
type	: type of the connection (ZMQ_PULL, ZMQ_PUSH, etc)
nbBufferMessage	: number of messages to be buffered
bufferSizeByte	: size of the zmq buffer in bytes
threadAffinity	: bit mask which determines which threads from the 0MQ I/O thread pool associated with the socket's context shall handle newly created connections (1 : means first, 2 : means second, 3 : means first and second, etc)
dataRate	: expected data rate (in kilobytes per second)

Returns

corresponding PZmqParam

Definition at line 88 of file PZmqBackend.cpp.

{
        PZmqParam param;
        param.type = type;
        param.nbBufferMessage = nbBufferMessage;
        param.bufferSizeByte = bufferSizeByte;
        param.threadAffinity = threadAffinity;
        param.dataRate = dataRate;
        return param;
}

References PZmqParam::bufferSizeByte, PZmqParam::dataRate, PZmqParam::nbBufferMessage, PZmqParam::threadAffinity, and PZmqParam::type.

Referenced by PZmqBackend::client().

Here is the caller graph for this function:

pzmq_createParamServer()

PZmqParam pzmq_createParamServer	(	int	type,
		int	nbBufferMessage,
		int	bufferSizeByte,
		size_t	threadAffinity,
		ssize_t	dataRate )

Create param for a client socket.

Parameters

type	: type of the connection (ZMQ_PULL, ZMQ_PUSH, etc)
nbBufferMessage	: number of messages to be buffered
bufferSizeByte	: size of the zmq buffer in bytes
threadAffinity	: bit mask which determines which threads from the 0MQ I/O thread pool associated with the socket's context shall handle newly created connections (1 : means first, 2 : means second, 3 : means first and second, etc)
dataRate	: expected data rate (in kilobytes per second)

Returns

corresponding PZmqParam

Definition at line 108 of file PZmqBackend.cpp.

{
        PZmqParam param;
        param.type = type;
        param.nbBufferMessage = nbBufferMessage;
        param.bufferSizeByte = bufferSizeByte;
        param.threadAffinity = threadAffinity;
        param.dataRate = dataRate;
        return param;
}

References PZmqParam::bufferSizeByte, PZmqParam::dataRate, PZmqParam::nbBufferMessage, PZmqParam::threadAffinity, and PZmqParam::type.

Referenced by PZmqBackend::server().

Here is the caller graph for this function:

statusToStr()

template<typename T>

std::string statusToStr

(

T

status

)

Convert PSendStatus into string.

Parameters

status

: PSendStatus to be converted

Returns

corresponding string

Definition at line 19 of file PZmqBackend_impl.h.

                                {
    if constexpr (std::is_same_v<T, PSendStatus::PSendStatus>) {
        switch (status) {
            case PSendStatus::OK: return "OK";
            case PSendStatus::SOCKET_NOT_AVAILABLE: return "SOCKET_NOT_AVAILABLE";
            case PSendStatus::NO_ROUTE_TO_RECEIVER: return "NO_ROUTE_TO_RECEIVER";
            case PSendStatus::SIGNAL_INTERRUPTION: return "SIGNAL_INTERRUPTION";
            case PSendStatus::BROKEN_BACKEND: return "BROKEN_BACKEND";
            case PSendStatus::BROKEN_SOCKET: return "BROKEN_SOCKET";
            case PSendStatus::CANNOT_SERIALIZE_DATA: return "CANNOT_SERIALIZE_DATA";
            default: return "UNKNOWN_SEND_STATUS";
        }
    } else if constexpr (std::is_same_v<T, PRecvStatus::PRecvStatus>) {
        switch (status) {
            case PRecvStatus::OK: return "OK";
            case PRecvStatus::SOCKET_NOT_AVAILABLE: return "SOCKET_NOT_AVAILABLE";
            case PRecvStatus::SIGNAL_INTERRUPTION: return "SIGNAL_INTERRUPTION";
            case PRecvStatus::BROKEN_BACKEND: return "BROKEN_BACKEND";
            case PRecvStatus::BROKEN_SOCKET: return "BROKEN_SOCKET";
            case PRecvStatus::NO_MESSAGE_RECEIVED: return "NO_MESSAGE_RECEIVED";
            case PRecvStatus::CANNOT_DESERIALIZE_DATA: return "CANNOT_DESERIALIZE_DATA";
            default: return "UNKNOWN_RECV_STATUS";
        }
    } else {
        return "UNKNOWN_STATUS_TYPE";
    }
}