TAO_LF_CH_Event Class Reference

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

#include <LF_CH_Event.h>

Inheritance diagram for TAO_LF_CH_Event:

Collaboration diagram for TAO_LF_CH_Event:

Public Member Functions
	TAO_LF_CH_Event ()
	Constructor.
virtual	~TAO_LF_CH_Event ()
	Destructor.
Public Member Functions inherited from TAO_LF_Event
	TAO_LF_Event ()
	Constructor.
virtual	~TAO_LF_Event ()
	Destructor.
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.
void	reset_state (LFS_STATE new_state)
	Reset the state, irrespective of the previous states.

Protected Member Functions
virtual bool	is_state_final () const
	Check whether we have reached the final state..
Protected Member Functions inherited from TAO_LF_Event
bool	keep_waiting_i () const
	Check if we should keep waiting.

Private Types
typedef ACE_Hash_Map_Manager_Ex< TAO_LF_Follower *, int, ACE_Hash< void * >, ACE_Equal_To< TAO_LF_Follower * >, TAO_SYNCH_MUTEX >	HASH_MAP

Private Member Functions
virtual void	state_changed_i (LFS_STATE new_state)
	Validate and change the state.
virtual bool	successful_i () const
virtual bool	error_detected_i () const
virtual void	set_state (LFS_STATE new_state)
	Set the state irrespective of anything.
virtual int	bind (TAO_LF_Follower *follower)
	Bind a follower.
virtual int	unbind (TAO_LF_Follower *follower)
	Unbind the follower.
void	validate_state_change (LFS_STATE new_state)

Private Attributes
LFS_STATE	prev_state_
	The previous state that the LF_CH_Event was in.
HASH_MAP	followers_

Friends
class	TAO_LF_Multi_Event

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 }
	The current state. More...
Static Public Member Functions inherited from TAO_LF_Event
static const char *	state_name (LFS_STATE st)
	The current state.
Protected Attributes inherited from TAO_LF_Event
LFS_STATE	state_
	The current state.
TAO_LF_Follower *	follower_
	The bounded follower.

Detailed Description

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

Concrete event types and manipulation class which is used for connection handling purposes.

Member Typedef Documentation

HASH_MAP

typedef ACE_Hash_Map_Manager_Ex<TAO_LF_Follower *, int, ACE_Hash<void *>, ACE_Equal_To<TAO_LF_Follower *>, TAO_SYNCH_MUTEX> TAO_LF_CH_Event::HASH_MAP

private

Constructor & Destructor Documentation

TAO_LF_CH_Event()

TAO_LF_CH_Event::TAO_LF_CH_Event

(

)

Constructor.

~TAO_LF_CH_Event()

TAO_LF_CH_Event::~TAO_LF_CH_Event ( )

virtual

Destructor.

Member Function Documentation

bind()

int TAO_LF_CH_Event::bind ( TAO_LF_Follower * follower )

privatevirtual

Bind a follower.

An event can be waited on by at most one follower thread, this method is used to bind the waiting thread to the event, in order to let the event signal any important state changes.

This is virtual to allow the LF_Multi_Event derived type share the follower with all the subordinate LF_CH_Events.

Returns

-1 if the LF_Event is already bound, 0 otherwise

Reimplemented from TAO_LF_Event.

error_detected_i()

bool TAO_LF_CH_Event::error_detected_i ( ) const

privatevirtual

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

Implements TAO_LF_Event.

is_state_final()

bool TAO_LF_CH_Event::is_state_final ( ) const

protectedvirtual

Check whether we have reached the final state..

Implements TAO_LF_Event.

set_state()

void TAO_LF_CH_Event::set_state ( LFS_STATE new_state )

privatevirtual

Set the state irrespective of anything.

Reimplemented from TAO_LF_Event.

state_changed_i()

void TAO_LF_CH_Event::state_changed_i ( LFS_STATE new_state )

privatevirtual

Validate and change the state.

Implements TAO_LF_Event.

successful_i()

bool TAO_LF_CH_Event::successful_i ( ) const

privatevirtual

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

Implements TAO_LF_Event.

unbind()

int TAO_LF_CH_Event::unbind ( TAO_LF_Follower * follower )

privatevirtual

Unbind the follower.

Reimplemented from TAO_LF_Event.

validate_state_change()

void TAO_LF_CH_Event::validate_state_change ( LFS_STATE new_state )

private

Friends And Related Symbol Documentation

TAO_LF_Multi_Event

friend class TAO_LF_Multi_Event

friend

The TAO_LF_Multi_Event class is another specialization of TAO_LF_Event, used for aggregating many connection handlers into a single event object. It requires friendship so that it can check the is_state_final() flag on each of its contained connection handlers.

Member Data Documentation

followers_

HASH_MAP TAO_LF_CH_Event::followers_

private

prev_state_

LFS_STATE TAO_LF_CH_Event::prev_state_

private

The previous state that the LF_CH_Event was in.

---

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

• LF_CH_Event.h
• LF_CH_Event.cpp