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

#include <PEmptyBackend.h>

Public Types
typedef DataStreamMsg	Message
	Define the type of message used by the PAbstractSocketManager. More...

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

typedef int	Socket
	Define the socket of the backend used by the PAbstractSocketManager. More...

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

Static Public Member Functions
static Param	client (const std::string &address, size_t port)
	Create param for a client socket. More...

static void	close (Socket &socket)
	Close the given socket. More...

static bool	createClientSocket (Socket &socket, const PEmptyParam &param)
	Create a client socket. More...

static bool	createClientSocket (Socket &socket, const std::string &address, size_t port, const PEmptyParam &param)
	Create a client socket. More...

static bool	createServerSocket (Socket &socket, const PEmptyParam &param)
	Create a client socket. More...

static bool	createServerSocket (Socket &socket, const std::string &address, size_t port, const PEmptyParam &param)
	Create a client 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, const Message &msg, PSendFlag::PSendFlag flag)
	Send message on the given socket. More...

static Param	server (const std::string &address, size_t port)
	Create param for a server socket. More...

Detailed Description

Backend to use Mock library with PAbtractSocket.

Definition at line 22 of file PEmptyBackend.h.

Member Typedef Documentation

◆ Message

typedef DataStreamMsg PEmptyBackend::Message

Define the type of message used by the PAbstractSocketManager.

Definition at line 27 of file PEmptyBackend.h.

◆ Param

typedef PEmptyParam PEmptyBackend::Param

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

Definition at line 29 of file PEmptyBackend.h.

◆ Socket

typedef int PEmptyBackend::Socket

Define the socket of the backend used by the PAbstractSocketManager.

Definition at line 25 of file PEmptyBackend.h.

Constructor & Destructor Documentation

◆ PEmptyBackend()

PEmptyBackend::PEmptyBackend ( )

Default constructor of PEmptyBackend.

Definition at line 11 of file PEmptyBackend.cpp.

                             {
         
 }

Member Function Documentation

◆ client()

PEmptyBackend::Param PEmptyBackend::client	(	const std::string &	address,
		size_t	port
	)

static

Create param for a client socket.

Parameters

address	: address of the server to be connected to
port	: port to be used

Returns: corresponding PZmqParam

Definition at line 20 of file PEmptyBackend.cpp.

                                                                               {
         PEmptyBackend::Param param;
         param.address = address;
         param.port = port;
         return param;
 }

References PEmptyParam::address, and PEmptyParam::port.

Referenced by server().

Here is the caller graph for this function:

◆ close()

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

static

Close the given socket.

Parameters

[out] socket : socket to be closed

Definition at line 132 of file PEmptyBackend.cpp.

                                                      {
         
 }

◆ createClientSocket() [1/2]

bool PEmptyBackend::createClientSocket	(	PEmptyBackend::Socket &	socket,
		const PEmptyParam &	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 63 of file PEmptyBackend.cpp.

                                                                                              {
         return true;
 }

◆ createClientSocket() [2/2]

bool PEmptyBackend::createClientSocket	(	PEmptyBackend::Socket &	socket,
		const std::string &	address,
		size_t	port,
		const PEmptyParam &	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 43 of file PEmptyBackend.cpp.

                                                                                                                                      {
         return true;
 }

◆ createServerSocket() [1/2]

bool PEmptyBackend::createServerSocket	(	PEmptyBackend::Socket &	socket,
		const PEmptyParam &	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 72 of file PEmptyBackend.cpp.

                                                                                              {
         return true;
 }

◆ createServerSocket() [2/2]

bool PEmptyBackend::createServerSocket	(	PEmptyBackend::Socket &	socket,
		const std::string &	address,
		size_t	port,
		const PEmptyParam &	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 54 of file PEmptyBackend.cpp.

                                                                                                                                      {
         return true;
 }

◆ isConnected()

bool PEmptyBackend::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 140 of file PEmptyBackend.cpp.

                                                                  {
         return true;
 }

◆ mockToMsg()

void PEmptyBackend::mockToMsg	(	PEmptyBackend::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 158 of file PEmptyBackend.cpp.

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

References msgData(), and msgResize().

Here is the call graph for this function:

◆ msgData() [1/2]

const DataStreamIter PEmptyBackend::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 116 of file PEmptyBackend.cpp.

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

Referenced by mockToMsg(), and msgToMock().

Here is the caller graph for this function:

◆ msgData() [2/2]

DataStreamIter PEmptyBackend::msgData ( PEmptyBackend::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 124 of file PEmptyBackend.cpp.

                                                               {
         return msg.data();
 }

◆ msgResize()

void PEmptyBackend::msgResize	(	PEmptyBackend::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 100 of file PEmptyBackend.cpp.

                                                                       {
         msg.resize(sizeMsg);
 }

Referenced by mockToMsg().

Here is the caller graph for this function:

◆ msgSize()

size_t PEmptyBackend::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 108 of file PEmptyBackend.cpp.

                                                             {
         return msg.size();
 }

Referenced by msgToMock().

Here is the caller graph for this function:

◆ msgToMock()

void PEmptyBackend::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 148 of file PEmptyBackend.cpp.

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

References msgData(), and msgSize().

Here is the call graph for this function:

◆ recv()

bool PEmptyBackend::recv	(	PEmptyBackend::Socket &	socket,
		PEmptyBackend::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 92 of file PEmptyBackend.cpp.

                                                                                                          {
         return false;
 }

◆ send()

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

static

Send message on the given socket.

Parameters

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

Returns: true on success, false otherwise

Definition at line 82 of file PEmptyBackend.cpp.

                                                                                                                {
         return true;
 }

◆ server()

PEmptyBackend::Param PEmptyBackend::server	(	const std::string &	address,
		size_t	port
	)

static

Create param for a server socket.

Parameters

address	: address of the server to be connected to
port	: port to be used

Returns: corresponding PZmqParam

Definition at line 32 of file PEmptyBackend.cpp.

                                                                               {
         return PEmptyBackend::client(address, port);
 }

References client().

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/tmp_project/PhoenixSocket/src/PEmptyBackend.h
/builds/CTA-LAPP/PHOENIX_LIBS2/PhoenixZMQ/tmp_project/PhoenixSocket/src/PEmptyBackend.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ Message

◆ Param

◆ Socket

Constructor & Destructor Documentation

◆ PEmptyBackend()

Member Function Documentation

◆ client()

◆ close()

◆ createClientSocket() [1/2]

◆ createClientSocket() [2/2]

◆ createServerSocket() [1/2]

◆ createServerSocket() [2/2]

◆ isConnected()

◆ mockToMsg()

◆ msgData() [1/2]

◆ msgData() [2/2]

◆ msgResize()

◆ msgSize()

◆ msgToMock()

◆ recv()

◆ send()

◆ server()