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:

[legend]Collaboration diagram for TAO_LF_CH_Event:

[legend]List of all members.

[NOHEADER]
int	successful (void) const
int	error_detected (void) const
virtual int	is_state_final (void)
	Check whether we have reached the final state..
Public Member Functions
	TAO_LF_CH_Event (void)
	Constructor.
virtual	~TAO_LF_CH_Event (void)
	Destructor.
Private Member Functions
virtual void	state_changed_i (int new_state)
	Validate and change the state.
virtual void	set_state (int new_state)
	Set the state irrespective of anything.
Private Attributes
int	prev_state_
	The previous state that the LF_CH_Event was in.
Friends
class	TAO_LF_Multi_Event

---

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.

Definition at line 37 of file LF_CH_Event.h.

---

Constructor & Destructor Documentation

TAO_BEGIN_VERSIONED_NAMESPACE_DECL TAO_LF_CH_Event::TAO_LF_CH_Event (  void   )

Constructor. Definition at line 9 of file LF_CH_Event.cpp. : TAO_LF_Event (), prev_state_ (TAO_LF_Event::LFS_IDLE) { }

TAO_LF_CH_Event::~TAO_LF_CH_Event (  void   )  [virtual]

Destructor. Definition at line 16 of file LF_CH_Event.cpp. { }

---

Member Function Documentation

int TAO_LF_CH_Event::error_detected (  void   )  const [virtual]

Return 1 if an error was detected while waiting for the event Implements TAO_LF_Event. Definition at line 80 of file LF_CH_Event.cpp. References prev_state_. Referenced by TAO_LF_Multi_Event::error_detected(). { if (this->prev_state_ == TAO_LF_Event::LFS_CONNECTION_WAIT) return this->state_ == TAO_LF_Event::LFS_CONNECTION_CLOSED; return this->state_ == TAO_LF_Event::LFS_TIMEOUT; }

int TAO_LF_CH_Event::is_state_final (  void   )  [protected, virtual]

Check whether we have reached the final state.. Implements TAO_LF_Event. Definition at line 100 of file LF_CH_Event.cpp. Referenced by TAO_LF_Multi_Event::is_state_final(), and set_state(). { return this->state_ == TAO_LF_Event::LFS_CONNECTION_CLOSED; }

void TAO_LF_CH_Event::set_state (  int  new_state  )  [private, virtual]

Set the state irrespective of anything. Reimplemented from TAO_LF_Event. Definition at line 89 of file LF_CH_Event.cpp. References is_state_final(). { // @@ NOTE: Is this still required? if (this->is_state_final () == 0 && new_state == TAO_LF_Event::LFS_TIMEOUT) { this->state_ = new_state; } }

void TAO_LF_CH_Event::state_changed_i (  int  new_state  )  [private, virtual]

Validate and change the state. Implements TAO_LF_Event. Definition at line 21 of file LF_CH_Event.cpp. References prev_state_. { if (this->state_ == new_state) return; // Validate the state change if (this->state_ == TAO_LF_Event::LFS_IDLE) { // From the LFS_IDLE state we can only become active. if (new_state == TAO_LF_Event::LFS_CONNECTION_WAIT) { this->prev_state_ = this->state_; this->state_ = new_state; } return; } else if (this->state_ == TAO_LF_Event::LFS_CONNECTION_WAIT) { // Only a few states are possible from CONNECTION_WAIT states if (new_state == TAO_LF_Event::LFS_CONNECTION_CLOSED || new_state == TAO_LF_Event::LFS_SUCCESS) { this->prev_state_ = this->state_; this->state_ = new_state; } return; } else if (this->state_ == TAO_LF_Event::LFS_SUCCESS) { if (new_state == TAO_LF_Event::LFS_CONNECTION_CLOSED) { this->prev_state_ = this->state_; this->state_ = new_state; } return; } else if (this->state_ == TAO_LF_Event::LFS_TIMEOUT) { if (new_state == TAO_LF_Event::LFS_CONNECTION_CLOSED) { // Dont reset the previous state this->state_ = new_state; } } return; }

int TAO_LF_CH_Event::successful (  void   )  const [virtual]

Return 1 if the condition was satisfied successfully, 0 if it has not Implements TAO_LF_Event. Definition at line 71 of file LF_CH_Event.cpp. References prev_state_. Referenced by TAO_LF_Multi_Event::successful(). { if (this->prev_state_ == TAO_LF_Event::LFS_CONNECTION_WAIT) return this->state_ == TAO_LF_Event::LFS_SUCCESS; return this->state_ == TAO_LF_Event::LFS_CONNECTION_CLOSED; }

---

Friends And Related Function Documentation

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. Definition at line 47 of file LF_CH_Event.h.

---

Member Data Documentation

int TAO_LF_CH_Event::prev_state_ [private]

The previous state that the LF_CH_Event was in. Definition at line 114 of file LF_CH_Event.h. Referenced by error_detected(), state_changed_i(), and successful().

---

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

• LF_CH_Event.h
• LF_CH_Event.cpp

---