---

ACE_TP_Token_Guard Class Reference

A helper class that helps grabbing, releasing and waiting on tokens for a thread that tries calling handle_events (). More...

#include <TP_Reactor.h>

Collaboration diagram for ACE_TP_Token_Guard:

[legend]List of all members.

Public Methods
	ACE_TP_Token_Guard (ACE_Select_Reactor_Token &token)
	Constructor that will grab the token for us. More...
	~ACE_TP_Token_Guard (void)
	Destructor. This will release the token if it hasnt been released till this point. More...
void	release_token (void)
	Release the token .. More...
int	is_owner (void)
	Returns whether the thread that created this object ownes the token or not. More...
int	grab_token (ACE_Time_Value *max_wait_time=0)
	A helper method that grabs the token for us, after which the thread that owns that can do some actual work. More...
int	acquire_token (ACE_Time_Value *max_wait_time=0)
Private Methods
	ACE_TP_Token_Guard (void)
Private Attributes
ACE_Select_Reactor_Token &	token_
	The Select Reactor token. More...
int	owner_
	Flag that indicate whether the thread that created this object owns the token or not. A value of 0 indicates that this class hasnt got the token (and hence the thread) and a value of 1 vice-versa. More...

---

Detailed Description

A helper class that helps grabbing, releasing and waiting on tokens for a thread that tries calling handle_events ().

In short, this class will be owned by one thread by creating on the stack. This class gives the status of the ownership of the token and manages the ownership

Definition at line 86 of file TP_Reactor.h.

---

Constructor & Destructor Documentation

ACE_INLINE ACE_TP_Token_Guard::ACE_TP_Token_Guard (  ACE_Select_Reactor_Token &    token )

Constructor that will grab the token for us. Definition at line 51 of file TP_Reactor.i. :token_ (token), owner_ (0) { }

ACE_INLINE ACE_TP_Token_Guard::~ACE_TP_Token_Guard (  void    )

Destructor. This will release the token if it hasnt been released till this point. Definition at line 59 of file TP_Reactor.i. References ACE_MT, and owner_. { if (this->owner_ == 1) { ACE_MT (this->token_.release ()); this->owner_ = 0; } }

ACE_TP_Token_Guard::ACE_TP_Token_Guard (  void    )  [private]

---

Member Function Documentation

int ACE_TP_Token_Guard::acquire_token (  ACE_Time_Value *    max_wait_time = 0 )

A helper method that grabs the token for us, after which the thread that owns that can do some actual work. This differs from grab_token () as it uses acquire () to get the token instead of acquire_read () Definition at line 61 of file TP_Reactor.cpp. References ACE_MT, ACE_TRACE, ETIME, ACE_OS::gettimeofday, and owner_. Referenced by ACE_TP_Reactor::handle_socket_events, and ACE_TP_Reactor::remove_handler. { ACE_TRACE ("ACE_TP_Token_Guard::acquire_token"); // Try to grab the lock. If someone if already there, don't wake // them up, just queue up in the thread pool. int result = 0; if (max_wait_time) { ACE_Time_Value tv = ACE_OS::gettimeofday (); tv += *max_wait_time; ACE_MT (result = this->token_.acquire (0, 0, &tv)); } else { ACE_MT (result = this->token_.acquire ()); } // Now that this thread owns the token let us make // Check for timeouts and errors. if (result == -1) { if (errno == ETIME) return 0; else return -1; } // We got the token and so let us mark ourseleves as owner this->owner_ = 1; return result; }

int ACE_TP_Token_Guard::grab_token (  ACE_Time_Value *    max_wait_time = 0 )

A helper method that grabs the token for us, after which the thread that owns that can do some actual work. Todo: Should probably be called acquire_read_token () Definition at line 19 of file TP_Reactor.cpp. References ACE_MT, ACE_TRACE, ETIME, ACE_OS::gettimeofday, ACE_TP_Reactor::no_op_sleep_hook, and owner_. Referenced by ACE_TP_Reactor::handle_events. { ACE_TRACE ("ACE_TP_Token_Guard::grab_token"); // The order of these events is very subtle, modify with care. // Try to grab the lock. If someone if already there, don't wake // them up, just queue up in the thread pool. int result = 0; if (max_wait_time) { ACE_Time_Value tv = ACE_OS::gettimeofday (); tv += *max_wait_time; ACE_MT (result = this->token_.acquire_read (&ACE_TP_Reactor::no_op_sleep_hook, 0, &tv)); } else { ACE_MT (result = this->token_.acquire_read (&ACE_TP_Reactor::no_op_sleep_hook)); } // Now that this thread owns the token let us make // Check for timeouts and errors. if (result == -1) { if (errno == ETIME) return 0; else return -1; } // We got the token and so let us mark ourselves as owner this->owner_ = 1; return result; }

ACE_INLINE int ACE_TP_Token_Guard::is_owner (  void    )

Returns whether the thread that created this object ownes the token or not. Definition at line 81 of file TP_Reactor.i. References owner_. Referenced by ACE_TP_Reactor::handle_events, and ACE_TP_Reactor::remove_handler. { return this->owner_; }

ACE_INLINE void ACE_TP_Token_Guard::release_token (  void    )

Release the token .. Definition at line 69 of file TP_Reactor.i. References ACE_MT, and owner_. Referenced by ACE_TP_Reactor::handle_notify_events, ACE_TP_Reactor::handle_socket_events, and ACE_TP_Reactor::handle_timer_events. { if (this->owner_) { ACE_MT (this->token_.release ()); // We are not the owner anymore.. this->owner_ = 0; } }

---

Member Data Documentation

int ACE_TP_Token_Guard::owner_ [private]

Flag that indicate whether the thread that created this object owns the token or not. A value of 0 indicates that this class hasnt got the token (and hence the thread) and a value of 1 vice-versa. Definition at line 126 of file TP_Reactor.h. Referenced by acquire_token, grab_token, is_owner, release_token, and ~ACE_TP_Token_Guard.

ACE_Select_Reactor_Token& ACE_TP_Token_Guard::token_ [private]

The Select Reactor token. Definition at line 120 of file TP_Reactor.h.

---

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

• TP_Reactor.h
• TP_Reactor.cpp
• TP_Reactor.i

---