PZmqBackend Class Reference

Backend to use ZMQ library with PAbtractSocket. More...

#include <PZmqBackend.h>

Public Types
typedef zmq::message_t	Message
	Define the type of message used by the PAbstractSocketManager. More...
typedef PZmqParam	Param
	Define the type of extra parameters which can be used to create a Socket used by the PAbstractSocketManager. More...
typedef zmq::socket_t *	Socket
	Define the socket of the backend used by the PAbstractSocketManager. More...

Public Member Functions
	PZmqBackend ()
	Default constructor of PZmqBackend. More...

Static Public Member Functions
static Param	client (const std::string &address, size_t port, zmq::context_t *context=NULL, int type=ZMQ_PULL, int nbBufferMessage=10000, int bufferSizeByte=1000000, size_t threadAffinity=0lu, ssize_t dataRate=200000l)
	Create a client parameter. More...
static void	close (Socket &socket)
	Close the given socket. More...
static bool	createClientSocket (Socket &socket, const Param &param)
	Create a client socket. More...
static bool	createClientSocket (Socket &socket, const std::string &address, size_t port, const PZmqParam &param)
	Create a client socket. More...
static bool	createServerSocket (Socket &socket, const Param &param)
	Create a server socket. More...
static bool	createServerSocket (Socket &socket, const std::string &address, size_t port, const PZmqParam &param)
	Create a server socket. More...
static bool	isConnected (const Socket &socket)
	Close the given socket. More...
static void	mockToMsg (Message &msg, DataStreamMsg &mockMsg)
	Copy mock message data into current backend message. More...
static const DataStreamIter	msgData (const Message &msg)
	Get the data of a message. More...
static DataStreamIter	msgData (Message &msg)
	Get the data of a message. More...
static void	msgResize (Message &msg, size_t sizeMsg)
	Resize a message. More...
static size_t	msgSize (const Message &msg)
	Get the size of a message. More...
static void	msgToMock (DataStreamMsg &mockMsg, const Message &msg)
	Copy current backend message data into mock message. More...
static bool	recv (Socket &socket, Message &msg, PRecvFlag::PRecvFlag flag)
	Recieve message from the given socket. More...
static bool	send (Socket &socket, Message &msg, PSendFlag::PSendFlag flag)
	Send message on the given socket. More...
static Param	server (const std::string &address, size_t port, zmq::context_t *context=NULL, int type=ZMQ_PUSH, int nbBufferMessage=10000, int bufferSizeByte=1000000, size_t threadAffinity=0lu, ssize_t dataRate=200000l)
	Create a server parameter. More...

Detailed Description

Backend to use ZMQ library with PAbtractSocket.

Definition at line 38 of file PZmqBackend.h.

Member Typedef Documentation

Message

typedef zmq::message_t PZmqBackend::Message

Define the type of message used by the PAbstractSocketManager.

Definition at line 43 of file PZmqBackend.h.

Param

typedef PZmqParam PZmqBackend::Param

Define the type of extra parameters which can be used to create a Socket used by the PAbstractSocketManager.

Definition at line 45 of file PZmqBackend.h.

Socket

typedef zmq::socket_t* PZmqBackend::Socket

Define the socket of the backend used by the PAbstractSocketManager.

Definition at line 41 of file PZmqBackend.h.

Constructor & Destructor Documentation

PZmqBackend()

PZmqBackend::PZmqBackend

(

)

Default constructor of PZmqBackend.

Definition at line 62 of file PZmqBackend.cpp.

                        {
        
}

Member Function Documentation

client()

PZmqBackend::Param PZmqBackend::client ( const std::string &  address, size_t  port, zmq::context_t *  context = NULL, int  type = ZMQ_PULL, int  nbBufferMessage = 10000, int  bufferSizeByte = 1000000, size_t  threadAffinity = 0lu, ssize_t  dataRate = 200000l  )

static

Create a client parameter.

Parameters

address	: address to be connected to
port	: port to be used
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 PZmqBackend::Param (or PZmqParam)

Definition at line 77 of file PZmqBackend.cpp.

                                                                                                                                                                                             {
        return pzmq_createParamClient(address, port, context, type, nbBufferMessage, bufferSizeByte, threadAffinity, dataRate);
}

References pzmq_createParamClient().

Here is the call graph for this function:

close()

void PZmqBackend::close ( PZmqBackend::Socket &  socket )

static

Close the given socket.

Parameters

[out]

socket

: socket to be closed

Definition at line 227 of file PZmqBackend.cpp.

                                                 {
        pzmq_closeServerSocket(socket);
}

References pzmq_closeServerSocket().

Here is the call graph for this function:

createClientSocket() [1/2]

bool PZmqBackend::createClientSocket ( Socket &  socket, const Param &  param  )

static

Create a client socket.

Parameters

[out]	socket	: socket to be created
	param	: extra customisable parameters for the creation of the socket (depends on the backend)

Returns

true if the socket has been created, false otherwise

Definition at line 127 of file PZmqBackend.cpp.

                                                                                   {
        socket = pzmq_createClientSocket(*param.context, param.address, param.port, param.type, param.nbBufferMessage,
                                        param.bufferSizeByte, param.threadAffinity, param.dataRate);
        return socket != NULL;
}

References PZmqParam::address, PZmqParam::bufferSizeByte, PZmqParam::context, PZmqParam::dataRate, PZmqParam::nbBufferMessage, PZmqParam::port, pzmq_createClientSocket(), PZmqParam::threadAffinity, and PZmqParam::type.

Here is the call graph for this function:

createClientSocket() [2/2]

bool PZmqBackend::createClientSocket ( PZmqBackend::Socket &  socket, const std::string &  address, size_t  port, const PZmqParam &  param  )

static

Create a client socket.

Parameters

[out]	socket	: socket to be created
	address	: address of the server, the client has to connect to
	port	: port to be used for the connection
	param	: extra customisable parameters for the creation of the socket (depends on the backend)

Returns

true if the socket has been created, false otherwise

Definition at line 103 of file PZmqBackend.cpp.

                                                                                                                               {
        socket = pzmq_createClientSocket(*param.context, address, port, param.type, param.nbBufferMessage,
                                        param.bufferSizeByte, param.threadAffinity, param.dataRate);
        return socket != NULL;
}

References PZmqParam::bufferSizeByte, PZmqParam::context, PZmqParam::dataRate, PZmqParam::nbBufferMessage, pzmq_createClientSocket(), PZmqParam::threadAffinity, and PZmqParam::type.

Here is the call graph for this function:

createServerSocket() [1/2]

bool PZmqBackend::createServerSocket ( Socket &  socket, const Param &  param  )

static

Create a server socket.

Parameters

[out]	socket	: socket to be created
	param	: extra customisable parameters for the creation of the socket (depends on the backend)

Returns

true if the socket has been created, false otherwise

Definition at line 138 of file PZmqBackend.cpp.

                                                                                   {
        socket = pzmq_createServerSocket(*param.context, param.port, param.type, param.nbBufferMessage, param.bufferSizeByte,
                                                        param.threadAffinity, param.dataRate);
        return socket != NULL;
}

References PZmqParam::bufferSizeByte, PZmqParam::context, PZmqParam::dataRate, PZmqParam::nbBufferMessage, PZmqParam::port, pzmq_createServerSocket(), PZmqParam::threadAffinity, and PZmqParam::type.

Here is the call graph for this function:

createServerSocket() [2/2]

bool PZmqBackend::createServerSocket ( PZmqBackend::Socket &  socket, const std::string &  address, size_t  port, const PZmqParam &  param  )

static

Create a server socket.

Parameters

[out]	socket	: socket to be created
	address	: address of the server, the client has to connect to
	port	: port to be used for the connection
	param	: extra customisable parameters for the creation of the socket (depends on the backend)

Returns

true if the socket has been created, false otherwise

Definition at line 116 of file PZmqBackend.cpp.

                                                                                                                               {
        socket = pzmq_createServerSocket(*param.context, port, param.type, param.nbBufferMessage, param.bufferSizeByte,
                                                        param.threadAffinity, param.dataRate);
        return socket != NULL;
}

References PZmqParam::bufferSizeByte, PZmqParam::context, PZmqParam::dataRate, PZmqParam::nbBufferMessage, pzmq_createServerSocket(), PZmqParam::threadAffinity, and PZmqParam::type.

Here is the call graph for this function:

isConnected()

bool PZmqBackend::isConnected ( const Socket &  socket )

static

Close the given socket.

Parameters

socket

: socket to be checked

Returns

true if the socket is connected, false otherwise

Definition at line 235 of file PZmqBackend.cpp.

                                                             {
        if(socket != NULL){
#if (CPPZMQ_VERSION_MAJOR*100 + CPPZMQ_VERSION_MINOR*10 + CPPZMQ_VERSION_PATCH) >= 471 
                return socket->handle() != NULL;
#else
                return socket->connected();
#endif
        }else{
                return false;
        }
}

mockToMsg()

void PZmqBackend::mockToMsg ( PZmqBackend::Message &  msg, DataStreamMsg &  mockMsg  )

static

Copy mock message data into current backend message.

Parameters

[out]	msg	: message of the current backend to be converted
	mockMsg	: mock message

Definition at line 261 of file PZmqBackend.cpp.

                                                                            {
        size_t dataSize(mockMsg.size());
        PZmqBackend::msgResize(msg, dataSize);
        memcpy(PZmqBackend::msgData(msg), mockMsg.data(), dataSize);
}

References msgData(), and msgResize().

Here is the call graph for this function:

msgData() [1/2]

const DataStreamIter PZmqBackend::msgData ( const Message &  msg )

static

Get the data of a message.

Parameters

msg	: message to be used

Returns

data of the message in bytes

Definition at line 212 of file PZmqBackend.cpp.

                                                                       {
        return (const DataStreamIter)msg.data();
}

Referenced by mockToMsg(), and msgToMock().

Here is the caller graph for this function:

msgData() [2/2]

DataStreamIter PZmqBackend::msgData ( PZmqBackend::Message &  msg )

static

Get the data of a message.

Parameters

msg	: message to be used

Returns

data of the message in bytes

Definition at line 220 of file PZmqBackend.cpp.

                                                           {
        return (DataStreamIter)msg.data();
}

msgResize()

void PZmqBackend::msgResize ( PZmqBackend::Message &  msg, size_t  sizeMsg  )

static

Resize a message.

Parameters

[out]	msg	: message to be resized
	sizeMsg	: new size of the message

Definition at line 196 of file PZmqBackend.cpp.

                                                                   {
        msg.rebuild(sizeMsg);
}

Referenced by mockToMsg().

Here is the caller graph for this function:

msgSize()

size_t PZmqBackend::msgSize ( const Message &  msg )

static

Get the size of a message.

Parameters

msg	: message to be used

Returns

size of the message in bytes

Definition at line 204 of file PZmqBackend.cpp.

                                                         {
        return msg.size();
}

Referenced by msgToMock().

Here is the caller graph for this function:

msgToMock()

void PZmqBackend::msgToMock ( DataStreamMsg &  mockMsg, const Message &  msg  )

static

Copy current backend message data into mock message.

Parameters

[out]	mockMsg	: mock message
	msg	: message of the current backend to be converted

Definition at line 251 of file PZmqBackend.cpp.

                                                                                  {
        size_t dataSize(PZmqBackend::msgSize(msg));
        mockMsg.resize(dataSize);
        memcpy(mockMsg.data(), PZmqBackend::msgData(msg), dataSize);
}

References msgData(), and msgSize().

Here is the call graph for this function:

recv()

bool PZmqBackend::recv ( PZmqBackend::Socket &  socket, PZmqBackend::Message &  msg, PRecvFlag::PRecvFlag  flag  )

static

Recieve message from the given socket.

Parameters

socket	: socket to be used
msg	: message to be recieved
flag	: flags to be used to send the message (BLOCK, NON_BLOCK, etc)

Returns

true on success, false otherwise

Definition at line 183 of file PZmqBackend.cpp.

                                                                                                   {
        if(socket != NULL){
                zmq::recv_result_t res = socket->recv(msg, convertToRecvFlag(flag));
                return res.has_value();         //Seems, if there is no value, there is also no error
        }else{
                return false;
        }
}

References convertToRecvFlag().

Here is the call graph for this function:

send()

bool PZmqBackend::send ( PZmqBackend::Socket &  socket, PZmqBackend::Message &  msg, PSendFlag::PSendFlag  flag  )

static

Send message on the given socket.

Parameters

socket	: socket to be used
msg	: message to be sent
flag	: flag to be used to send the message (BLOCK, NON_BLOCK, etc)

Returns

true on success, false otherwise

Definition at line 159 of file PZmqBackend.cpp.

                                                                                                   {
        if(socket != NULL){
                zmq::send_result_t res = socket->send(msg, convertToSendFlag(flag));
                return res.has_value();         //Seems, if there is no value, there is also no error
        }else{
                return false;
        }
}

References convertToSendFlag().

Here is the call graph for this function:

server()

PZmqBackend::Param PZmqBackend::server ( const std::string &  address, size_t  port, zmq::context_t *  context = NULL, int  type = ZMQ_PUSH, int  nbBufferMessage = 10000, int  bufferSizeByte = 1000000, size_t  threadAffinity = 0lu, ssize_t  dataRate = 200000l  )

static

Create a server parameter.

Parameters

address	: address to be connected to
port	: port to be used
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 PZmqBackend::Param (or PZmqParam)

Definition at line 92 of file PZmqBackend.cpp.

                                                                                                                                                                                             {
        return pzmq_createParamServer(address, port, context, type, nbBufferMessage, bufferSizeByte, threadAffinity, dataRate);
}

References pzmq_createParamServer().

Here is the call graph for this function:

---

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

• /builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixZMQ/src/PZmqBackend.h
• /builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixZMQ/src/PZmqBackend.cpp