PZmqBackend.cpp File Reference

#include "PZmqBackend.h"

Include dependency graph for PZmqBackend.cpp:

Go to the source code of this file.

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.
zmq::recv_flags	convertToRecvFlag (PRecvFlag::PRecvFlag flag)
	Convert a recv flag into zmq flag.
zmq::send_flags	convertToSendFlag (PSendFlag::PSendFlag flag)
	Convert a send flag into zmq flag.
PZmqParam	pzmq_createParamClient (int type, int nbBufferMessage, int bufferSizeByte, size_t threadAffinity, ssize_t dataRate, int linger)
	Create param for a client socket.
PZmqParam	pzmq_createParamServer (int type, int nbBufferMessage, int bufferSizeByte, size_t threadAffinity, ssize_t dataRate, int linger)
	Create param for a client socket.

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 43 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:

convertToRecvFlag()

zmq::recv_flags convertToRecvFlag

(

PRecvFlag::PRecvFlag

flag

)

Convert a recv flag into zmq flag.

Parameters

flag	: generic PRecvFlag

Returns

corresponding zmq::recv_flags

Definition at line 69 of file PZmqBackend.cpp.

                                                        {
        if(flag == PRecvFlag::NON_BLOCK){return zmq::recv_flags::dontwait;}
        else{return zmq::recv_flags::none;}
}

Referenced by PZmqSocket::recvMsg().

Here is the caller graph for this function:

convertToSendFlag()

zmq::send_flags convertToSendFlag

(

PSendFlag::PSendFlag

flag

)

Convert a send flag into zmq flag.

Parameters

flag	: generic PSendFlag

Returns

corresponding zmq::send_flags

Definition at line 60 of file PZmqBackend.cpp.

                                                        {
        if(flag == PSendFlag::NON_BLOCK){return zmq::send_flags::dontwait;}
        else{return zmq::send_flags::none;}
}

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,
		int	linger )

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)
linger	: linger period for socket shutdown

Returns

corresponding PZmqParam

Definition at line 84 of file PZmqBackend.cpp.

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

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

Referenced by PZmqSocketGenerator::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,
		int	linger )

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)
linger	: linger period for socket shutdown

Returns

corresponding PZmqParam

Definition at line 104 of file PZmqBackend.cpp.

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

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

Referenced by PZmqSocketGenerator::server().

Here is the caller graph for this function: