Example of a mock socket with vector of messages. More...

#include <PMockBackend.h>

Collaboration diagram for PMockSocket:

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

typedef PMockParam	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 PMockSocket.

bool	createClientSocket (const PSocketParam &socketParam, const Param &extraParam)
	Initialise a client socket.

bool	createServerSocket (const PSocketParam &socketParam, const Param &extraParam)
	Initialise a server socket.

bool	isConnected () const
	Say if the PMockSocket is connected.

	PMockSocket ()
	Default constructor of hte PMockSocket.

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)
	Recieved 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 (const Message &msg, PSendFlag::PSendFlag flag=PSendFlag::BLOCK)
	Specialisation to send a Message with the socket.

void	setIsMockRecord (bool isMockRecord)
	Set the mock prefix (where to find/save it)

void	setMockPrefix (const std::string &mockPrefix)
	Set the mock prefix (where to find/save it)

virtual	~PMockSocket ()
	Default destructor of hte PMockSocket.

Private Attributes
Param	p_extraParam
	Extra parameters of the socket.

PGenericVecMock< DataStreamMsg >	p_mock
	Mock handler.

PSocketParam	p_socketParam
	Parameters of the socket.

Detailed Description

Example of a mock socket with vector of messages.

Definition at line 17 of file PMockBackend.h.

Member Typedef Documentation

◆ Message

typedef DataStreamMsg PMockSocket::Message

Define the type of message used by the PAbstractSocketManager.

Definition at line 20 of file PMockBackend.h.

◆ Param

typedef PMockParam PMockSocket::Param

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

Definition at line 22 of file PMockBackend.h.

Constructor & Destructor Documentation

◆ PMockSocket()

PMockSocket::PMockSocket ( )

Default constructor of hte PMockSocket.

Definition at line 27 of file PMockBackend.cpp.

                        {
        
}

◆ ~PMockSocket()

PMockSocket::~PMockSocket ( )

virtual

Default destructor of hte PMockSocket.

Definition at line 32 of file PMockBackend.cpp.

                         {
        
}

Member Function Documentation

◆ close()

void PMockSocket::close ( )

Close the PMockSocket.

Definition at line 112 of file PMockBackend.cpp.

                       {
        p_mock.close();
}

References p_mock.

◆ createClientSocket()

bool PMockSocket::createClientSocket	(	const PSocketParam &	socketParam,
		const Param &	extraParam )

Initialise a client socket.

Parameters

socketParam	: parameters to be use to initialise the socket (hostname, port, etc)
extraParam	: extra customisable parameters for the creation of the socket (depends on the backend)

Definition at line 40 of file PMockBackend.cpp.

                                                                                                          {
        p_socketParam = socketParam;
        p_extraParam = extraParam;
        
        return true;
}

References p_extraParam, and p_socketParam.

Referenced by PMockBackend::createClientSocket(), createServerSocket(), and phoenix_createMockBackend().

Here is the caller graph for this function:

◆ createServerSocket()

bool PMockSocket::createServerSocket	(	const PSocketParam &	socketParam,
		const Param &	extraParam )

Initialise a server socket.

Parameters

socketParam	: parameters to be use to initialise the socket (hostname, port, etc)
extraParam	: extra customisable parameters for the creation of the socket (depends on the backend)

Definition at line 51 of file PMockBackend.cpp.

                                                                                                          {
        return createClientSocket(socketParam, extraParam);
}

References createClientSocket().

Here is the call graph for this function:

◆ isConnected()

bool PMockSocket::isConnected ( ) const

Say if the PMockSocket is connected.

Returns: true if the PMockSocket is connected, false otherwise

Definition at line 107 of file PMockBackend.cpp.

                                   {
        return true;
}

◆ recvData()

template<typename T>

PRecvStatus::PRecvStatus PMockSocket::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 61 of file PMockBackend_impl.h.

                                                                             {
        PRecvStatus::PRecvStatus recvStatus = PRecvStatus::OK;
        PMockSocket::Message msg;
        if(p_mock.getIsRecord()){
                if(socket_serialize_message(msg, data)){
                        return recvMsg(msg, flag);
                }else{
                        return PRecvStatus::CANNOT_DESERIALIZE_DATA;
                }
        }
        else{
                recvStatus = recvMsg(msg, flag);
                //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)){
                                recvStatus = PRecvStatus::CANNOT_DESERIALIZE_DATA;
                        }
                }else{
                        recvStatus = PRecvStatus::NO_MESSAGE_RECEIVED;
                }
        }
        return recvStatus;
}

References PRecvStatus::CANNOT_DESERIALIZE_DATA, PRecvStatus::NO_MESSAGE_RECEIVED, PRecvStatus::OK, p_mock, recvMsg(), and socket_serialize_message().

Here is the call graph for this function:

◆ recvMsg()

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

Recieved data with the socket.

Parameters

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

Returns: status of the recv

Definition at line 90 of file PMockBackend.cpp.

                                                                                             {
        if(p_mock.getIsRecord()){
                p_mock.append(msg);
                return PRecvStatus::OK;
        }else{
                p_mock.getCurrentValue(msg);
                if(msg.size() == 0lu){  //If the message is empty, it is not recieved
                        return PRecvStatus::NO_MESSAGE_RECEIVED;
                }else{
                        return PRecvStatus::OK;
                }
        }
}

References PRecvStatus::NO_MESSAGE_RECEIVED, PRecvStatus::OK, and p_mock.

Referenced by recvData().

Here is the caller graph for this function:

◆ sendData()

template<typename T>

PSendStatus::PSendStatus PMockSocket::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 32 of file PMockBackend_impl.h.

                                                                                   {
        if(p_mock.getIsRecord()){
                PMockSocket::Message msg;
                if(socket_serialize_message(msg, data)){
                        return sendMsg(msg, flag);
                }else{
                        return PSendStatus::CANNOT_SERIALIZE_DATA;
                }
        }else{
                T referenceData;
                PMockSocket::Message referenceMsg;
                p_mock.getCurrentValue(referenceMsg);     //Let's get the reference message
                if(referenceMsg.size() != 0lu){
                        DataStreamIter iter = (DataStreamIter)referenceMsg.data();
                        check_stream_assert(data_message_load<T>(iter, referenceData));
                        std::stringstream index;
                        index << p_mock.getCurrentIndex();
                        check_stream_assert(phoenix_check_stream("mock '"+p_mock.getFileName()+"', [mock index = "+index.str()+"]", data, referenceData));
                }
                return PSendStatus::OK;
        }
}

References PSendStatus::CANNOT_SERIALIZE_DATA, PSendStatus::OK, p_mock, sendMsg(), and socket_serialize_message().

Here is the call graph for this function:

◆ sendMsg()

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

Specialisation to send a Message with the socket.

Parameters

msg	: Message to be sent
flag	: sending flag (BLOCK, NON_BLOCK)

Returns: status of the send

Definition at line 76 of file PMockBackend.cpp.

                                                                                                   {
        if(p_mock.getIsRecord()){
                p_mock.append(msg);
        }else{
                check_stream_assert(p_mock.checkCurrentValue("PMockSocket::sendMsg", msg));
        }
        return PSendStatus::OK;
}

References PSendStatus::OK, and p_mock.

Referenced by sendData().

Here is the caller graph for this function:

◆ setIsMockRecord()

void PMockSocket::setIsMockRecord ( bool isMockRecord )

Set the mock prefix (where to find/save it)

Parameters

isMockRecord : true if the mock has to be recorded

Definition at line 67 of file PMockBackend.cpp.

                                                  {
        p_mock.setIsRecord(isMockRecord);
}

References p_mock.

Referenced by phoenix_createMockBackend().

Here is the caller graph for this function:

◆ setMockPrefix()

void PMockSocket::setMockPrefix ( const std::string & mockPrefix )

Set the mock prefix (where to find/save it)

Parameters

mockPrefix : prefix of the mock to find or write it

Definition at line 58 of file PMockBackend.cpp.

                                                           {
        std::stringstream socketFileName;
        socketFileName << mockPrefix << p_socketParam.hostname << "_" << p_socketParam.port << ".pmockbackend";
        p_mock.setFileName(socketFileName.str());
}

References p_mock, and p_socketParam.

Referenced by phoenix_createMockBackend().

Here is the caller graph for this function:

Member Data Documentation

◆ p_extraParam

Param PMockSocket::p_extraParam

private

Extra parameters of the socket.

Definition at line 49 of file PMockBackend.h.

Referenced by createClientSocket().

◆ p_mock

PGenericVecMock<DataStreamMsg> PMockSocket::p_mock

private

Mock handler.

Definition at line 45 of file PMockBackend.h.

Referenced by close(), recvData(), recvMsg(), sendData(), sendMsg(), setIsMockRecord(), and setMockPrefix().

◆ p_socketParam

PSocketParam PMockSocket::p_socketParam

private

Parameters of the socket.

Definition at line 47 of file PMockBackend.h.

Referenced by createClientSocket(), and setMockPrefix().

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

/builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSocket/src/PMockBackend.h
/builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSocket/src/PMockBackend.cpp
/builds/CTA-LAPP/PHOENIX_LIBS2/network/PhoenixSocket/src/PMockBackend_impl.h

Public Types

Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Message

◆ Param

Constructor & Destructor Documentation

◆ PMockSocket()

◆ ~PMockSocket()

Member Function Documentation

◆ close()

◆ createClientSocket()

◆ createServerSocket()

◆ isConnected()

◆ recvData()

◆ recvMsg()

◆ sendData()

◆ sendMsg()

◆ setIsMockRecord()

◆ setMockPrefix()

Member Data Documentation

◆ p_extraParam

◆ p_mock

◆ p_socketParam