AbstractGatewayMessageReceiver Class Reference

Interface for any object that wishes to be notified by AbstractMessageIOGateway::DoInput() about received Messages. More...

#include <AbstractMessageIOGateway.h>

Inheritance diagram for AbstractGatewayMessageReceiver:

[legend]List of all members.

Public Member Functions
	AbstractGatewayMessageReceiver ()
	Default constructor.
virtual	~AbstractGatewayMessageReceiver ()
	Destructor.
void	CallMessageReceivedFromGateway (const MessageRef &msg, void *userData=NULL)
	This method calls MessageReceivedFromGateway() and then AfterMessageReceivedFromGateway().
Protected Member Functions
virtual void	MessageReceivedFromGateway (const MessageRef &msg, void *userData)=0
	Called whenever a new incoming Message is available for us to look at.
virtual void	AfterMessageReceivedFromGateway (const MessageRef &msg, void *userData)
	Called after each call to MessageReceivedFromGateway().
virtual void	BeginMessageReceivedFromGatewayBatch ()
	This method will be called just before MessageReceivedFromGateway() and AfterMessageReceivedFromGateway() are called one or more times.
virtual void	EndMessageReceivedFromGatewayBatch ()
	This method will be called just after MessageReceivedFromGateway() and AfterMessageReceivedFromGateway() have been called one or more times.
Friends
class	AbstractMessageIOGateway

---

Detailed Description

Interface for any object that wishes to be notified by AbstractMessageIOGateway::DoInput() about received Messages.

Definition at line 18 of file AbstractMessageIOGateway.h.

---

Member Function Documentation

void AbstractGatewayMessageReceiver::CallMessageReceivedFromGateway	(	const MessageRef &	msg,
		void *	userData = NULL
	)			[inline]

This method calls MessageReceivedFromGateway() and then AfterMessageReceivedFromGateway().

AbstractMessageIOGateway::DoInput() should call this method whenever it has received a new Message from its DataIO object..

Parameters:

	msg	MessageRef containing the new Message
	userData	This is a miscellaneous value that may be used by some gateways for various purposes. Or it may be ignored if the MessageRef is sufficient.

Definition at line 34 of file AbstractMessageIOGateway.h.

References AfterMessageReceivedFromGateway(), BeginMessageReceivedFromGatewayBatch(), and MessageReceivedFromGateway().

Referenced by SignalMessageIOGateway::DoInputImplementation().

virtual void AbstractGatewayMessageReceiver::MessageReceivedFromGateway	(	const MessageRef &	msg,
		void *	userData
	)			[protected, pure virtual]

Called whenever a new incoming Message is available for us to look at.

Parameters:

	msg	Reference to the new Message to process.
	userData	This is a miscellaneous value that may be used by some gateways for various purposes.

Implemented in QueueGatewayMessageReceiver, DumbReflectSession, StorageReflectSession, ThreadWorkerSession, and ThreadSupervisorSession.

Referenced by CallMessageReceivedFromGateway(), and AbstractMessageIOGateway::SynchronousMessageReceivedFromGateway().

virtual void AbstractGatewayMessageReceiver::AfterMessageReceivedFromGateway	(	const MessageRef &	msg,
		void *	userData
	)			[inline, protected, virtual]

Called after each call to MessageReceivedFromGateway().

Useful when there is something that needs to be done after the subclass has finished its processing. Default implementation is a no-op.

Parameters:

	msg	MessageRef containing the Message that was just passed to MessageReceivedFromGateway()
	userData	userData value that was just passed to MessageReceivedFromGateway()

Reimplemented in StorageReflectSession.

Definition at line 58 of file AbstractMessageIOGateway.h.

Referenced by CallMessageReceivedFromGateway(), and AbstractMessageIOGateway::SynchronousAfterMessageReceivedFromGateway().

virtual void AbstractGatewayMessageReceiver::BeginMessageReceivedFromGatewayBatch

(

)

[inline, protected, virtual]

This method will be called just before MessageReceivedFromGateway() and AfterMessageReceivedFromGateway() are called one or more times.

Default implementation is a no-op.

Definition at line 63 of file AbstractMessageIOGateway.h.

Referenced by CallMessageReceivedFromGateway(), and AbstractMessageIOGateway::SynchronousBeginMessageReceivedFromGatewayBatch().

virtual void AbstractGatewayMessageReceiver::EndMessageReceivedFromGatewayBatch

(

)

[inline, protected, virtual]

This method will be called just after MessageReceivedFromGateway() and AfterMessageReceivedFromGateway() have been called one or more times.

Default implementation is a no-op.

Definition at line 68 of file AbstractMessageIOGateway.h.

Referenced by AbstractMessageIOGateway::SynchronousEndMessageReceivedFromGatewayBatch().

---

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

• AbstractMessageIOGateway.h

---