PZmqSocket Class Reference

PhoenixSocket API bridge to ZMQ socket. More...

#include <PZmqBackend.h>

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

Public Member Functions
void	close ()
	Close the socket.
bool	createClientSocket (zmq::context_t &context, const PSocketParam &socketParam, const Param &extraParam)
	Create a client socket.
bool	createServerSocket (zmq::context_t &context, const PSocketParam &socketParam, const Param &extraParam)
	Create a server socket.
bool	isConnected () const
	Check if the socket is connected.
	PZmqSocket ()
	Default constructor of PZmqSocket.
template<typename T>
PRecvStatus::PRecvStatus	recvData (T &data, PRecvFlag::PRecvFlag flag=PRecvFlag::BLOCK)
	Recieved data with the socket.
PRecvStatus::PRecvStatus	recvMsg (Message &msg, PRecvFlag::PRecvFlag flag=PRecvFlag::BLOCK)
	Receive data with the socket.
template<typename T>
PSendStatus::PSendStatus	sendData (const T &data, PSendFlag::PSendFlag flag=PSendFlag::BLOCK)
	Send data with the socket.
PSendStatus::PSendStatus	sendMsg (Message &msg, PSendFlag::PSendFlag flag=PSendFlag::BLOCK)
	Send data with the socket.
virtual	~PZmqSocket ()
	Destructor of PZmqSocket.

Private Attributes
zmq::socket_t *	p_socket
	ZMQ Socket.

Detailed Description

PhoenixSocket API bridge to ZMQ socket.

Definition at line 38 of file PZmqBackend.h.

Member Typedef Documentation

Message

typedef zmq::message_t PZmqSocket::Message

Define the type of message used by the PAbstractSocketManager.

Definition at line 41 of file PZmqBackend.h.

Param

typedef PZmqParam PZmqSocket::Param

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

Definition at line 43 of file PZmqBackend.h.

Constructor & Destructor Documentation

PZmqSocket()

PZmqSocket::PZmqSocket

(

)

Default constructor of PZmqSocket.

Definition at line 121 of file PZmqBackend.cpp.

:p_socket(nullptr)
{
 
}

References p_socket.

~PZmqSocket()

PZmqSocket::~PZmqSocket ( )

virtual

Destructor of PZmqSocket.

Definition at line 128 of file PZmqBackend.cpp.

                       {
    close();
}

References close().

Here is the call graph for this function:

Member Function Documentation

close()

void PZmqSocket::close

(

)

Close the socket.

Definition at line 239 of file PZmqBackend.cpp.

                      {
    if(p_socket != nullptr){
        p_socket->close();
        delete p_socket;
        p_socket = nullptr;
    }
}

References p_socket.

Referenced by ~PZmqSocket().

Here is the caller graph for this function:

createClientSocket()

bool PZmqSocket::createClientSocket	(	zmq::context_t &	context,
		const PSocketParam &	socketParam,
		const Param &	extraParam )

Create a client socket.

Parameters

context	: zmq context where to create socket
socketParam	: parameters of the server (hostname, port), the client has to connect to
extraParam	: 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.

                                                                                                                     {
    p_socket = pzmq_createClientSocket(context, socketParam.hostname, socketParam.port, extraParam.type, extraParam.nbBufferMessage,
                    extraParam.bufferSizeByte, extraParam.threadAffinity, extraParam.dataRate);
#if (CPPZMQ_VERSION_MAJOR*100 + CPPZMQ_VERSION_MINOR*10 + CPPZMQ_VERSION_PATCH) >= 471 
                p_socket->set(zmq::sockopt::rcvtimeo, socketParam.recvTimeOut);
                p_socket->set(zmq::sockopt::sndtimeo, socketParam.sendTimeOut);
#else
                p_socket->setsockopt(ZMQ_RCVTIMEO, &socketParam.recvTimeOut, sizeof(int));
                p_socket->setsockopt(ZMQ_SNDTIMEO, &socketParam.sendTimeOut, sizeof(int));
#endif
    return p_socket != nullptr;
}

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

Referenced by PZmqBackend::createClientSocket().

Here is the call graph for this function:

Here is the caller graph for this function:

createServerSocket()

bool PZmqSocket::createServerSocket	(	zmq::context_t &	context,
		const PSocketParam &	socketParam,
		const Param &	extraParam )

Create a server socket.

Parameters

context	: zmq context where to create socket
socketParam	: parameters of the server (hostname, port), the client has to connect to
extraParam	: 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 157 of file PZmqBackend.cpp.

                                                                                                                     {
    p_socket = pzmq_createServerSocket(context, socketParam.port, extraParam.type, extraParam.nbBufferMessage, extraParam.bufferSizeByte,
                extraParam.threadAffinity, extraParam.dataRate);
#if (CPPZMQ_VERSION_MAJOR*100 + CPPZMQ_VERSION_MINOR*10 + CPPZMQ_VERSION_PATCH) >= 471 
                p_socket->set(zmq::sockopt::rcvtimeo, socketParam.recvTimeOut);
                p_socket->set(zmq::sockopt::sndtimeo, socketParam.sendTimeOut);
#else
                p_socket->setsockopt(ZMQ_RCVTIMEO, &socketParam.recvTimeOut, sizeof(int));
                p_socket->setsockopt(ZMQ_SNDTIMEO, &socketParam.sendTimeOut, sizeof(int));
#endif
    return p_socket != nullptr;
}

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

Referenced by PZmqBackend::createServerSocket().

Here is the call graph for this function:

Here is the caller graph for this function:

isConnected()

bool PZmqSocket::isConnected

(

)

const

Check if the socket is connected.

Returns

true if the socket is connected, false otherwise

Definition at line 231 of file PZmqBackend.cpp.

                                  {
    if(p_socket != nullptr){
        return p_socket->handle() != nullptr;
    }
    return false;
}

References p_socket.

recvData()

template<typename T>

PRecvStatus::PRecvStatus PZmqSocket::recvData	(	T &	data,
		PRecvFlag::PRecvFlag	flag = PRecvFlag::BLOCK )

Recieved data with the socket.

Parameters

[out]	data	: data to be recieved with the socket
	flag	: recieving flag (BLOCK, NON_BLOCK)

Returns

status of the recv

Definition at line 71 of file PZmqBackend_impl.h.

                                                                            {
        PRecvStatus::PRecvStatus recvStatus = PRecvStatus::OK;
        Message msg;
        recvStatus = recvMsg(msg, flag);
    if(recvStatus == PRecvStatus::OK){
        //If the message is empty we cannot initialise the given data, so, this is an error
        if(msg.size() != 0lu){
            DataStreamIter iter = (DataStreamIter)msg.data();
            if(!data_message_load<T>(iter, data)){
                return PRecvStatus::CANNOT_DESERIALIZE_DATA;
            }
        }else{
            return PRecvStatus::NO_MESSAGE_RECEIVED;
        }
    }
        
    return recvStatus;
}

References recvMsg().

Here is the call graph for this function:

recvMsg()

PRecvStatus::PRecvStatus PZmqSocket::recvMsg	(	Message &	msg,
		PRecvFlag::PRecvFlag	flag = PRecvFlag::BLOCK )

Receive data with the socket.

Parameters

msg	: message to be received with the socket
flag	: receiving flag (BLOCK, NON_BLOCK)

Returns

status of the recv

Definition at line 206 of file PZmqBackend.cpp.

                                                                                {
    try {
                zmq::recv_result_t result = p_socket->recv(msg, convertToRecvFlag(flag));
                return checkRecvStatus(result);
        } catch(const zmq::error_t& e)
        {
                if(e.num() == ENOTSOCK){
                        return PRecvStatus::BROKEN_SOCKET;
                }
                else if(e.num() == ENOTSUP || e.num() == EFSM || e.num() == ETERM || e.num() == EINVAL){
                        return PRecvStatus::BROKEN_BACKEND;
                }
                else if(e.num() == EINTR){
                        return PRecvStatus::SIGNAL_INTERRUPTION;
                }
                else{
                        std::cerr << "Unknown ZMQ error in recv: " << e.what() << std::endl;
                        return PRecvStatus::BROKEN_BACKEND;
                }
        }
}

References checkRecvStatus(), convertToRecvFlag(), and p_socket.

Referenced by recvData().

Here is the call graph for this function:

Here is the caller graph for this function:

sendData()

template<typename T>

PSendStatus::PSendStatus PZmqSocket::sendData	(	const T &	data,
		PSendFlag::PSendFlag	flag = PSendFlag::BLOCK )

Send data with the socket.

Parameters

data	: data to be sent with the socket
flag	: sending flag (BLOCK, NON_BLOCK)

Returns

status of the send

Definition at line 53 of file PZmqBackend_impl.h.

                                                                                  {
    size_t dataSize(data_size<T>(data));
        Message msg;
        msg.rebuild(dataSize);
        DataStreamIter iter = (DataStreamIter)msg.data();
        if(data_message_save<T>(iter, data)){                   //Save the message
                return sendMsg(msg, flag);
        }else{
                return PSendStatus::CANNOT_SERIALIZE_DATA;
        }
}

References sendMsg().

Here is the call graph for this function:

sendMsg()

PSendStatus::PSendStatus PZmqSocket::sendMsg	(	Message &	msg,
		PSendFlag::PSendFlag	flag = PSendFlag::BLOCK )

Send data with the socket.

Parameters

msg	: message to be sent with the socket
flag	: sending flag (BLOCK, NON_BLOCK)

Returns

status of the send

Definition at line 175 of file PZmqBackend.cpp.

                                                                                {
    try {
        zmq::send_result_t result = p_socket->send(msg, convertToSendFlag(flag));
        return checkSendStatus(result);
    }
    catch(const zmq::error_t& e) {
 
        if(e.num() == ENOTSOCK){
            return PSendStatus::BROKEN_SOCKET;
        }
        else if(e.num() == ENOTSUP || e.num() == EFSM || e.num() == ETERM || e.num() == EINVAL){
            return PSendStatus::BROKEN_BACKEND;
        }
        else if(e.num() == EINTR){
            return PSendStatus::SIGNAL_INTERRUPTION;
        }
        else if(e.num() == EHOSTUNREACH){
            return PSendStatus::NO_ROUTE_TO_RECEIVER;
        }
        else{
            std::cerr << "Unknown ZMQ error in send: " << e.what() << std::endl;
            return PSendStatus::BROKEN_BACKEND;
        }
    }
}

References checkSendStatus(), convertToSendFlag(), and p_socket.

Referenced by sendData().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

p_socket

zmq::socket_t* PZmqSocket::p_socket

private

ZMQ Socket.

Definition at line 63 of file PZmqBackend.h.

Referenced by close(), createClientSocket(), createServerSocket(), isConnected(), PZmqSocket(), recvMsg(), and sendMsg().

---

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

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