TAO_LF_Invocation_Event Class Reference

Use the Leader/Follower loop to wait for one specific event in the invocation path. More...

#include <LF_Invocation_Event.h>

Inheritance diagram for TAO_LF_Invocation_Event:

Collaboration diagram for TAO_LF_Invocation_Event:

Public Member Functions
	TAO_LF_Invocation_Event (void)
	Constructor. More...
virtual	~TAO_LF_Invocation_Event (void)
	Destructor. More...
Public Member Functions inherited from TAO_LF_Event
	TAO_LF_Event (void)
	Constructor. More...
virtual	~TAO_LF_Event (void)
	Destructor. More...
virtual int	bind (TAO_LF_Follower *follower)
	Bind a follower. More...
virtual int	unbind (TAO_LF_Follower *follower)
	Unbind the follower. More...
void	reset_state (LFS_STATE new_state)
	Reset the state, irrespective of the previous states. More...
void	state_changed (LFS_STATE new_state, TAO_Leader_Follower &lf)
bool	successful (TAO_Leader_Follower &lf) const
bool	error_detected (TAO_Leader_Follower &lf) const
bool	keep_waiting (TAO_Leader_Follower &lf) const
	Check if we should keep waiting. More...

Protected Member Functions
virtual void	state_changed_i (LFS_STATE new_state)
	Validate and perform the state change. More...
virtual bool	successful_i (void) const
virtual bool	error_detected_i (void) const
Protected Member Functions inherited from TAO_LF_Event
bool	keep_waiting_i (void) const
	Check if we should keep waiting. More...

Private Member Functions
bool	is_state_final (void) const
	Check whether we have reached the final state.. More...

Additional Inherited Members
Public Types inherited from TAO_LF_Event
enum	LFS_STATE {   LFS_IDLE = 0, LFS_ACTIVE, LFS_CONNECTION_WAIT, LFS_SUCCESS,   LFS_FAILURE, LFS_TIMEOUT, LFS_CONNECTION_CLOSED }
Static Public Member Functions inherited from TAO_LF_Event
static const char *	state_name (LFS_STATE st)
Protected Attributes inherited from TAO_LF_Event
LFS_STATE	state_
	The current state. More...
TAO_LF_Follower *	follower_
	The bounded follower. More...

Detailed Description

Use the Leader/Follower loop to wait for one specific event in the invocation path.

Concrete event types and manipulation class through which the invocation data path would flow. Typically state changes of interest include whether a message has arrived, or timedout waiting for a message or if the connection is closed waiting for a message. Details of the states are documented within the class.

Constructor & Destructor Documentation

TAO_LF_Invocation_Event::TAO_LF_Invocation_Event

(

void

)

Constructor.

TAO_LF_Invocation_Event::~TAO_LF_Invocation_Event ( void  )

virtual

Destructor.

Member Function Documentation

bool TAO_LF_Invocation_Event::error_detected_i ( void  ) const

protectedvirtual

Return true if an error was detected while waiting for the event

Implements TAO_LF_Event.

bool TAO_LF_Invocation_Event::is_state_final ( void  ) const

privatevirtual

Check whether we have reached the final state..

Implements TAO_LF_Event.

void TAO_LF_Invocation_Event::state_changed_i ( LFS_STATE  new_state )

protectedvirtual

Validate and perform the state change.

This concrete class uses the following states declared in the class TAO_LF_Event

LFS_IDLE - The event is created, and is in initial state. LFS_ACTIVE - The event is active and it can transition to any of the following states, all the states are final. LFS_SUCCESS - The event has completed successfully. LFS_FAILURE - A failure has been detected while the event was active. LFS_TIMEOUT - The event has timed out. LFS_CONNECTION_CLOSED - The connection was closed when the state was active.

Implements TAO_LF_Event.

bool TAO_LF_Invocation_Event::successful_i ( void  ) const

protectedvirtual

Return true if the condition was satisfied successfully, false if it has not

Implements TAO_LF_Event.

---

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

• LF_Invocation_Event.h
• LF_Invocation_Event.cpp