TAO  2.1.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
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:
Inheritance graph
Collaboration diagram for TAO_LF_Invocation_Event:
Collaboration graph

Public Member Functions

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

Protected Member Functions

virtual void state_changed_i (int new_state)
 Validate and perform the state change.

Private Member Functions

int is_state_final (void)
 Check whether we have reached the final state..

Additional Inherited Members

- Public Types inherited from TAO_LF_Event
enum  {
- Static Public Member Functions inherited from TAO_LF_Event
static const char * state_name (int st)
- Protected Attributes inherited from TAO_LF_Event
int state_
 The current state.
 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 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  )


TAO_LF_Invocation_Event::~TAO_LF_Invocation_Event ( void  )


Member Function Documentation

int TAO_LF_Invocation_Event::error_detected ( void  ) const

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

Implements TAO_LF_Event.

int TAO_LF_Invocation_Event::is_state_final ( void  )

Check whether we have reached the final state..

Implements TAO_LF_Event.

void TAO_LF_Invocation_Event::state_changed_i ( int  new_state)

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.

int TAO_LF_Invocation_Event::successful ( void  ) const

Return 1 if the condition was satisfied successfully, 0 if it has not

Implements TAO_LF_Event.

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