CODEX_KeyService::ClientMessageAbsorber Class Reference

This class absorbs messages from clients. More...

#include <ClientMessageAbsorber.h>

Inheritance diagram for CODEX_KeyService::ClientMessageAbsorber:

[legend]Collaboration diagram for CODEX_KeyService::ClientMessageAbsorber:

[legend]List of all members.

Public Member Functions
	ClientMessageAbsorber (CODEX_Events::DeadPileType &deadPile, CODEX_Events::QType &eventQueue)
	Create a ClientMessageAbsorber.
virtual	~ClientMessageAbsorber ()
	Virtual destructor.
bool	handler (CODEX_Events::CloseEvent &event)
	Handle a CloseEvent.
bool	handler (ClientMessageEvent< RequestKeyMsg > &event)
	Handle a RequestKeyMsg.
bool	handler (ClientMessageEvent< SignedCreateKeyMsg > &event)
	Handle a signed CreateKeyMsg.
bool	handler (ClientMessageEvent< SignedWriteKeyMsg > &event)
	Handle a signed WriteKeyMsg.
bool	handler (ClientMessageEvent< SignedReadKeyMsg > &event)
	Handle a signed ReadKeyMsg.
virtual bool	handler (CloseEvent &event)=0
	Abstract handler for CloseEvent%s.
virtual bool	handler (EventAck &event)
	The base class is responsible for handling acknowledgements, which are relevant to whether the Activity is ready for deletion.
Protected Member Functions
void	sendEvent (EventBase *event, Activity *source, bool failure=false)
void	enableTerminate ()
	This method should be called when an Activity has received a CloseEvent or other indicator that it is no longer needed.
Protected Attributes
DeadPileType &	m_deadPile
	The pile of Activity%s to be garbage-collected.
QType &	m_queue
	The event queue.

---

Detailed Description

This class absorbs messages from clients.

This is just a black hole.

Definition at line 34 of file ClientMessageAbsorber.h.

---

Constructor & Destructor Documentation

ClientMessageAbsorber::ClientMessageAbsorber (  CODEX_Events::DeadPileType &  deadPile, CODEX_Events::QType &  eventQueue )

Create a ClientMessageAbsorber. Parameters: deadPile  The object adds itself to this when it is ready to be garbage-collected. This is handled by the Activity base class, though the derived class must call enableTerminate() before garbage collection can occur. eventQueue  The object adds events that it emits to this so that they can be handled. Definition at line 24 of file ClientMessageAbsorber.cc.

---

Member Function Documentation

void Activity::enableTerminate (   )  [protected, inherited]

This method should be called when an Activity has received a CloseEvent or other indicator that it is no longer needed. Actual termination will not occur until there are no remaining events outstanding (unacknowledged). Definition at line 63 of file Activity.cc. Referenced by CODEX_KeyService::ClientActivity::handler(), and CODEX_KeyService::ClientActivity::processRequest().

bool Activity::handler (  EventAck &  event  )  [virtual, inherited]

The base class is responsible for handling acknowledgements, which are relevant to whether the Activity is ready for deletion. If a derived class reimpliments this method, it must call this version explicitly. Definition at line 39 of file Activity.cc. Referenced by CODEX_Events::EventAck::handle(), and CODEX_KeyService::ClientActivity::handler().

void Activity::sendEvent (  EventBase *  event, Activity *  source, bool  failure = false )  [protected, inherited]

Parameters: event  New event to be added to the queue source  Source of event just handled, to which an acknowledgement should be sent. This is accessed by the method EventBase::source(). failure  Is the acknowledgment a negative ack? Definition at line 49 of file Activity.cc. References CODEX_Events::Activity::m_queue. Referenced by CODEX_APSS::InitActivity::addEvidence(), CODEX_APSS::MessageDeliverer::broadcast(), CODEX_KeyService::ClientActivity::close(), CODEX_Server::UnicastRequestHandler::handler(), CODEX_Server::ShareLabelChallengeHandler::handler(), CODEX_Server::ServerResponseHandler::handler(), CODEX_Server::QuorumBuilderAct::handler(), CODEX_APSS::MessageVerifier::handler(), CODEX_APSS::MessageProcessor::handler(), CODEX_APSS::InitActivity::handler(), CODEX_KeyService::DelegateResponseVerifier::handler(), CODEX_KeyService::DelegateRequestDistributor::handler(), CODEX_KeyService::ClientResponseSigner::handler(), CODEX_KeyService::ClientMessageVerifier::handler(), CODEX_KeyService::ClientMessageSigner::handler(), handler(), CODEX_KeyService::ClientActivity::handler(), CODEX_Server::BroadcastRequestHandler::handler(), CODEX_KeyService::VerifyWriteCallback::operator()(), CODEX_KeyService::SignWriteCallback::operator()(), CODEX_KeyService::SignReadCallback::operator()(), CODEX_KeyService::SignCreateCallback::operator()(), CODEX_APSS::MessageParser::operator()(), CODEX_KeyService::ClientWriteCallback::operator()(), CODEX_KeyService::ClientResponseParser::operator()(), CODEX_KeyService::ClientReadCallback::operator()(), CODEX_KeyService::ClientMessageParser::operator()(), CODEX_KeyService::ClientCreateCallback::operator()(), CODEX_KeyService::ClientActivity::processRequest(), CODEX_Server::QuorumBuilderAct::QuorumBuilderAct(), CODEX_APSS::MessageDeliverer::sendTo(), CODEX_Server::ShareLabelChallengeHandler::ShareLabelChallengeHandler(), and CODEX_APSS::TriggerActivity::TriggerActivity().

---

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

• ClientMessageAbsorber.h
• ClientMessageAbsorber.cc

---