Cpl::Itc::RequestMessage< SERVER, PAYLOAD > Class Template Reference

This template class represents a service request message to a particular server. More...

Detailed Description

template<class SERVER, class PAYLOAD>
class Cpl::Itc::RequestMessage< SERVER, PAYLOAD >

This template class represents a service request message to a particular server.

The SERVER argument of the template is the abstract interface of the server which services this message. This is the interface that the message uses to invoke the message operation. By definition, the SERVER must have a member function named "request" that returns nothing (void) and has a signature whose argument is a reference to the message defined by this template.

#include <RequestMessage.h>

Inheritance diagram for Cpl::Itc::RequestMessage< SERVER, PAYLOAD >:

Collaboration diagram for Cpl::Itc::RequestMessage< SERVER, PAYLOAD >:

Public Member Functions
	RequestMessage (SERVER &srv, PAYLOAD &payload, ReturnHandler &returnHandler)
	Constructor.
	RequestMessage (SAP< SERVER > &sapsrv, PAYLOAD &payload, ReturnHandler &returnHandler)
	Constructor.
virtual	~RequestMessage ()
	Destructor.
void	process () noexcept
	See Cpl::Itc::Message.
PAYLOAD &	getPayload ()
	Returns the payload associated with this request.
Public Member Functions inherited from Cpl::Itc::ServiceMessage
	ServiceMessage (ReturnHandler &rh) noexcept
	Constructor.
void	returnToSender () noexcept
	This operation is invoked by the server when it has completed the operation implemented as a part of this message.
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

RequestMessage() [1/2]

template<class SERVER , class PAYLOAD >

Cpl::Itc::RequestMessage< SERVER, PAYLOAD >::RequestMessage	(	SERVER &	srv,
		PAYLOAD &	payload,
		ReturnHandler &	returnHandler
	)

Constructor.

RequestMessage() [2/2]

template<class SERVER , class PAYLOAD >

Cpl::Itc::RequestMessage< SERVER, PAYLOAD >::RequestMessage	(	SAP< SERVER > &	sapsrv,
		PAYLOAD &	payload,
		ReturnHandler &	returnHandler
	)

Constructor.

~RequestMessage()

template<class SERVER , class PAYLOAD >

Cpl::Itc::RequestMessage< SERVER, PAYLOAD >::~RequestMessage ( )

virtual

Destructor.

Member Function Documentation

getPayload()

template<class SERVER , class PAYLOAD >

PAYLOAD & Cpl::Itc::RequestMessage< SERVER, PAYLOAD >::getPayload

(

)

Returns the payload associated with this request.

process()

template<class SERVER , class PAYLOAD >

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

virtualnoexcept

See Cpl::Itc::Message.

Implements Cpl::Itc::Message.

---

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

• Cpl/Itc/RequestMessage.h