CODEX_KeyService::ClientResponseEvent< MT > Class Template Reference

This class wraps a response for a client in an event. More...

#include <ClientResponseEvent.h>

Inheritance diagram for CODEX_KeyService::ClientResponseEvent< MT >:

[legend]Collaboration diagram for CODEX_KeyService::ClientResponseEvent< MT >:

[legend]List of all members.

Public Member Functions
	ClientResponseEvent (CODEX_Events::Activity *source, ClientResponseHandler *destination, const MT &message, bool acknowledge=false)
	Create a ClientResponseEvent specifying activities and the msg.
virtual	~ClientResponseEvent ()
	Virtual destructor.
const MT &	message () const
	The wrapped object.
bool	acknowledge () const
	Should this event be acknowledged?
bool	handle ()
	Handle this event -- invokes the appropriate handler from the destination Activity, which must have type ClientResponseHandler.
void	reRoute (ClientResponseHandler *newDestination)
	Re-route this event to another Activity.
int	marshal (unsigned char **pp)
	Forwards a marshal request to the wrapped object.
Activity *	source ()
	The Activity that created this event.
Protected Attributes
Activity *	m_source
	Source of this event.

---

Detailed Description

template<class MT>
class CODEX_KeyService::ClientResponseEvent< MT >

This class wraps a response for a client in an event.

The template argument is the message type, and specialization of the templated handler in ClientResponseHandler provides the needed polymorphism.

Definition at line 62 of file ClientResponseEvent.h.

---

Member Function Documentation

template<class MT> void CODEX_KeyService::ClientResponseEvent< MT >::reRoute (  ClientResponseHandler *  newDestination  )  [inline]

Re-route this event to another Activity. This is a much cheaper operation than copying the data to a new event. The CODEX_Events::Activity calling this should return false in its handler, so that the event will be re-added to the queue. Definition at line 98 of file ClientResponseEvent.h.

---

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

• ClientResponseEvent.h

---