Use the Leader/Follower loop to wait for one specific event in the invocation path. More...
#include <LF_Invocation_Event.h>
Public Member Functions | |
| TAO_LF_Invocation_Event () | |
| Constructor. | |
| virtual | ~TAO_LF_Invocation_Event () |
| Destructor. | |
 Public Member Functions inherited from TAO_LF_Event | |
| TAO_LF_Event () | |
| Constructor. | |
| virtual | ~TAO_LF_Event () |
| Destructor. | |
| virtual int | bind (TAO_LF_Follower *follower) |
| Bind a follower. | |
| virtual int | unbind (TAO_LF_Follower *follower) |
| Unbind the follower. | |
| 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 void | state_changed_i (LFS_STATE new_state) |
| Validate and perform the state change. | |
| virtual bool | successful_i () const |
| virtual bool | error_detected_i () const |
| Protected Member Functions inherited from TAO_LF_Event | |
| bool | keep_waiting_i () const |
| Check if we should keep waiting. | |
Private Member Functions | |
| bool | is_state_final () const |
| Check whether we have reached the final state.. | |
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 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::TAO_LF_Invocation_Event | ( | ) |
Constructor.
◆ ~TAO_LF_Invocation_Event()
|
virtual |
Destructor.
Member Function Documentation
◆ error_detected_i()
|
protectedvirtual |
Return true if an error was detected while waiting for the event
Implements TAO_LF_Event.
◆ is_state_final()
|
privatevirtual |
Check whether we have reached the final state..
Implements TAO_LF_Event.
◆ state_changed_i()
|
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.
◆ successful_i()
|
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:
