PIpBusBackend Class Reference

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

#include <PIpBusBackend.h>

Public Types
typedef UaMessage	Message
	Define the type of message used by the PAbstractSocketManager.
typedef PIpBusParam	Param
	Define the type of extra parameters which can be used to create a Socket.
typedef PIpBusSocket	Socket
	Define the socket of the backend used by the PAbstractSocketManager.

Public Member Functions
bool	createClientSocket (Socket &socket, const PSocketParam &socketParam, const Param &param)
	Create parameters for a client socket.
bool	createServerSocket (Socket &socket, const PSocketParam &socketParam, const Param &param)
	Create parameters for a server socket.
	PIpBusBackend ()
	Default constructor of PIpBusBackend.

Static Public Member Functions
static Param	client (std::string &connectionFilePath, std::string &connectionId)
	Create parameters for a client socket.
static void	mockToMsg (Message &msg, DataStreamMsg &mockMsg)
	Copy mock message data into current backend message.
static void	msgToMock (DataStreamMsg &mockMsg, const Message &msg)
	Copy current backend message data into mock message.
static Param	server (std::string &connectionFilePath, std::string &connectionId)
	Create parameters for a server socket.

Detailed Description

Backend to use Mock library with PAbtractSocket.

Definition at line 58 of file PIpBusBackend.h.

Member Typedef Documentation

Message

typedef UaMessage PIpBusBackend::Message

Define the type of message used by the PAbstractSocketManager.

Definition at line 63 of file PIpBusBackend.h.

Param

typedef PIpBusParam PIpBusBackend::Param

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

Definition at line 65 of file PIpBusBackend.h.

Socket

typedef PIpBusSocket PIpBusBackend::Socket

Define the socket of the backend used by the PAbstractSocketManager.

Definition at line 61 of file PIpBusBackend.h.

Constructor & Destructor Documentation

PIpBusBackend()

PIpBusBackend::PIpBusBackend

(

)

Default constructor of PIpBusBackend.

Definition at line 55 of file PIpBusBackend.cpp.

{
 
}

Member Function Documentation

client()

PIpBusBackend::Param PIpBusBackend::client ( std::string & connectionFilePath, std::string & connectionId )

static

Create parameters for a client socket.

Parameters

connectionFilePath	Path to the connection file containing IPBUS parameters.
connectionId	Device identifier.

Returns

Corresponding Param object.

Definition at line 65 of file PIpBusBackend.cpp.

                                                                                              {
        Param param;
        param.connectionFilePath = connectionFilePath;
        param.connectionId = connectionId;
        return param;
}

References PIpBusParam::connectionFilePath, and PIpBusParam::connectionId.

Referenced by server().

Here is the caller graph for this function:

createClientSocket()

bool PIpBusBackend::createClientSocket	(	PIpBusBackend::Socket &	socket,
		const PSocketParam &	socketParam,
		const Param &	param )

Create parameters for a client socket.

Parameters

connectionFilePath	Path to the connection file containing IPBUS parameters.
connectionId	Device identifier.

Returns

Corresponding Param object.

Definition at line 86 of file PIpBusBackend.cpp.

                                                                                                                         {
        return socket.createClientSocket(param);
}

References PIpBusSocket::createClientSocket().

Here is the call graph for this function:

createServerSocket()

bool PIpBusBackend::createServerSocket	(	PIpBusBackend::Socket &	socket,
		const PSocketParam &	socketParam,
		const Param &	param )

Create parameters for a server socket.

Parameters

connectionFilePath	Path to the connection file containing IPBUS parameters.
connectionId	Device identifier.

Returns

Corresponding Param object.

Definition at line 95 of file PIpBusBackend.cpp.

                                                                                                                         {
        return socket.createServerSocket(param);
}

References PIpBusSocket::createServerSocket().

Here is the call graph for this function:

mockToMsg()

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

                                                                                {
    DataStreamIter iter = (DataStreamIter)mockMsg.data();
    data_message_load(iter, msg);
}

msgToMock()

void PIpBusBackend::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 109 of file PIpBusBackend.cpp.

                                                                                      {
    size_t dataSize(data_size(msg));
    mockMsg.resize(dataSize);
    DataStreamIter iter = (DataStreamIter)mockMsg.data();
    data_message_save(iter, msg);
}

server()

PIpBusBackend::Param PIpBusBackend::server ( std::string & connectionFilePath, std::string & connectionId )

static

Create parameters for a server socket.

Parameters

connectionFilePath	Path to the connection file containing IPBUS parameters.
connectionId	Device identifier.

Returns

Corresponding Param object.

Definition at line 77 of file PIpBusBackend.cpp.

                                                                                              {
        return PIpBusBackend::client(connectionFilePath, connectionId);
}

References client().

Here is the call graph for this function:

---

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

• /builds/mockplatform/ipbusmock/src/PIpBusBackend.h
• /builds/mockplatform/ipbusmock/src/PIpBusBackend.cpp