Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD > Class Template Reference

This template class represents a client response message, which is posted to the client's mailbox after the corresponding server request message is returned to the client via the server message returnToSender interface. More...

Detailed Description

template<class CLIENT, class SERVER, class PAYLOAD>
class Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >

This template class represents a client response message, which is posted to the client's mailbox after the corresponding server request message is returned to the client via the server message returnToSender interface.

The purpose of this class is to provide a standard model for confirmed asynchronous messages. The SERVER template argument is the type of the server interface that is used by the corresponding server request message. The CLIENT class type is the interface which is invoked by the response message when the client thread invokes the process routine inherited from the Message class.The CLIENT interface must contain a function named "response", which returns nothing (void) and takes a single argument, which is a reference to this template class type.

#include <ResponseMessage.h>

Inheritance diagram for Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >:

Collaboration diagram for Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >:

Public Member Functions
	ResponseMessage (CLIENT &client, PostApi &clientsMbox, SERVER &server, PAYLOAD &payload)
	Constructor.
	ResponseMessage (CLIENT &client, PostApi &clientsMbox, SAP< SERVER > &serverSap, PAYLOAD &payload)
	Constructor.
virtual	~ResponseMessage ()
	Destructor.
void	process () noexcept
	See Message.
RequestMessage< SERVER, PAYLOAD > &	getRequestMsg ()
	Returns a reference to the contained server-request-message.
PAYLOAD &	getPayload ()
	Returns a reference the payload associated with this request/response.
Public Member Functions inherited from Cpl::Itc::Message
virtual	~Message ()
	Virtual destructor.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.
Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.
	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Constructor & Destructor Documentation

ResponseMessage() [1/2]

template<class CLIENT , class SERVER , class PAYLOAD >

Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >::ResponseMessage	(	CLIENT &	client,
		PostApi &	clientsMbox,
		SERVER &	server,
		PAYLOAD &	payload
	)

Constructor.

ResponseMessage() [2/2]

template<class CLIENT , class SERVER , class PAYLOAD >

Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >::ResponseMessage	(	CLIENT &	client,
		PostApi &	clientsMbox,
		SAP< SERVER > &	serverSap,
		PAYLOAD &	payload
	)

Constructor.

~ResponseMessage()

template<class CLIENT , class SERVER , class PAYLOAD >

Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >::~ResponseMessage ( )

virtual

Destructor.

Member Function Documentation

getPayload()

template<class CLIENT , class SERVER , class PAYLOAD >

PAYLOAD & Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >::getPayload

(

)

Returns a reference the payload associated with this request/response.

getRequestMsg()

template<class CLIENT , class SERVER , class PAYLOAD >

RequestMessage< SERVER, PAYLOAD > & Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >::getRequestMsg

(

)

Returns a reference to the contained server-request-message.

process()

template<class CLIENT , class SERVER , class PAYLOAD >

void Cpl::Itc::ResponseMessage< CLIENT, SERVER, PAYLOAD >::process ( )

virtualnoexcept

See Message.

Implements Cpl::Itc::Message.

---

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

• Cpl/Itc/ResponseMessage.h