PEmptyBackend Class Reference

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.
typedef PEmptyParam	Param
	Define the type of extra parameters which can be used to create a Socket used by the PAbstractSocketManager.
typedef PEmptySocket	Socket
	Define the socket of the backend used by the PAbstractSocketManager.

Public Member Functions
bool	createClientSocket (Socket &socket, const PSocketParam &socketParam, const Param &extraParam)
	Create a client socket.
bool	createServerSocket (Socket &socket, const PSocketParam &socketParam, const Param &extraParam)
	Create a Server socket.
	PEmptyBackend ()
	Default constructor of PEmptyBackend.

Static Public Member Functions
static Param	client ()
	Create param for a client socket.
static void	mockToMsg (Message &msg, DataStreamMsg &mockMsg)
	Copy mock message data into current backend message.
static const DataStreamIter	msgData (const Message &msg)
	Get the data of a message.
static DataStreamIter	msgData (Message &msg)
	Get the data of a message.
static void	msgResize (Message &msg, size_t sizeMsg)
	Resize a message.
static size_t	msgSize (const Message &msg)
	Get the size of a message.
static void	msgToMock (DataStreamMsg &mockMsg, const Message &msg)
	Copy current backend message data into mock message.
static Param	server ()
	Create param for a server socket.

Detailed Description

Backend to use Mock library with PAbtractSocket.

Definition at line 46 of file PEmptyBackend.h.

Member Typedef Documentation

Message

typedef DataStreamMsg PEmptyBackend::Message

Define the type of message used by the PAbstractSocketManager.

Definition at line 51 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 53 of file PEmptyBackend.h.

Socket

typedef PEmptySocket PEmptyBackend::Socket

Define the socket of the backend used by the PAbstractSocketManager.

Definition at line 49 of file PEmptyBackend.h.

Constructor & Destructor Documentation

PEmptyBackend()

PEmptyBackend::PEmptyBackend

(

)

Default constructor of PEmptyBackend.

Definition at line 81 of file PEmptyBackend.cpp.

                            {
        
}

Member Function Documentation

client()

PEmptyBackend::Param PEmptyBackend::client ( )

static

Create param for a client socket.

Returns

corresponding PEmptyParam

Definition at line 88 of file PEmptyBackend.cpp.

                                        {
        PEmptyBackend::Param param;
        return param;
}

Referenced by server().

Here is the caller graph for this function:

createClientSocket()

bool PEmptyBackend::createClientSocket	(	PEmptyBackend::Socket &	socket,
		const PSocketParam &	socketParam,
		const Param &	extraParam )

Create a client socket.

Parameters

[out]	socket	: socket to be created
	socketParam	: parameters of the socket (host, port, send/recv timeout)
	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 106 of file PEmptyBackend.cpp.

                                                                                                                                           {
        return socket.createClientSocket(socketParam, extraParam);
}

References PEmptySocket::createClientSocket().

Here is the call graph for this function:

createServerSocket()

bool PEmptyBackend::createServerSocket	(	PEmptyBackend::Socket &	socket,
		const PSocketParam &	socketParam,
		const Param &	extraParam )

Create a Server socket.

Parameters

[out]	socket	: socket to be created
	socketParam	: parameters of the socket (host, port, send/recv timeout)
	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 116 of file PEmptyBackend.cpp.

                                                                                                                                           {
        return socket.createServerSocket(socketParam, extraParam);
}

References PEmptySocket::createServerSocket().

Here is the call graph for this function:

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 166 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 140 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 148 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 124 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 132 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 156 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:

server()

PEmptyBackend::Param PEmptyBackend::server ( )

static

Create param for a server socket.

Returns

corresponding PEmptyParam

Definition at line 96 of file PEmptyBackend.cpp.

                                        {
        return PEmptyBackend::client();
}

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