PZmqBackend.h File Reference

#include "PSocketFlag.h"
#include "phoenix_data_stream.h"
#include "phoenix_zmq.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 ZMQ library with PAbtractSocket. More...
struct	PZmqParam
	Set of parameters to be passed to create a socket with zmq backend. More...

Functions
PZmqParam	pzmq_createParamClient (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 param for a client socket. More...
PZmqParam	pzmq_createParamServer (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 param for a client socket. More...

Function Documentation

pzmq_createParamClient()

PZmqParam pzmq_createParamClient	(	const std::string &	address,
		size_t	port,
		zmq::context_t *	context,
		int	type,
		int	nbBufferMessage,
		int	bufferSizeByte,
		size_t	threadAffinity,
		ssize_t	dataRate
	)

Create param for a client socket.

Parameters

address	: address of the server 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 PZmqParam

Definition at line 20 of file PZmqBackend.cpp.

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

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

Referenced by PZmqBackend::client().

Here is the caller graph for this function:

pzmq_createParamServer()

PZmqParam pzmq_createParamServer	(	const std::string &	address,
		size_t	port,
		zmq::context_t *	context,
		int	type,
		int	nbBufferMessage,
		int	bufferSizeByte,
		size_t	threadAffinity,
		ssize_t	dataRate
	)

Create param for a client socket.

Parameters

address	: address of the server 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 PZmqParam

Definition at line 46 of file PZmqBackend.cpp.

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

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

Referenced by PZmqBackend::server().

Here is the caller graph for this function: