ACE_Dev_Poll_Reactor::Token_Guard Class Reference

A helper class that helps grabbing, releasing and waiting on tokens for a thread that needs access to the reactor's token. More...

#include <Dev_Poll_Reactor.h>

Collaboration diagram for ACE_Dev_Poll_Reactor::Token_Guard:

[legend]List of all members.

Public Member Functions
	Token_Guard (ACE_Dev_Poll_Reactor_Token &token)
	Constructor that will grab the token for us.
	~Token_Guard (void)
void	release_token (void)
	Release the token ..
int	is_owner (void)
int	acquire_quietly (ACE_Time_Value *max_wait=0)
int	acquire (ACE_Time_Value *max_wait=0)
Private Member Functions
	Token_Guard (void)
Private Attributes
ACE_Dev_Poll_Reactor_Token &	token_
	The Reactor token.
int	owner_

---

Detailed Description

A helper class that helps grabbing, releasing and waiting on tokens for a thread that needs access to the reactor's token.

Definition at line 1174 of file Dev_Poll_Reactor.h.

---

Constructor & Destructor Documentation

ACE_INLINE ACE_Dev_Poll_Reactor::Token_Guard::Token_Guard (  ACE_Dev_Poll_Reactor_Token &  token  )

Constructor that will grab the token for us. Definition at line 193 of file Dev_Poll_Reactor.inl. References ACE_Dev_Poll_Reactor_Token. : token_ (token), owner_ (0) { }

ACE_INLINE ACE_Dev_Poll_Reactor::Token_Guard::~Token_Guard (  void   )

Destructor. This will release the token if it hasn't been released till this point Definition at line 201 of file Dev_Poll_Reactor.inl. References owner_. { if (this->owner_ == 1) { ACE_MT (this->token_.release ()); this->owner_ = 0; } }

ACE_Dev_Poll_Reactor::Token_Guard::Token_Guard (  void   )  [private]

---

Member Function Documentation

int ACE_Dev_Poll_Reactor::Token_Guard::acquire (  ACE_Time_Value *  max_wait = 0  )

A helper method that acquires the token at a high priority, and does wake the current token holder. Definition at line 2613 of file Dev_Poll_Reactor.cpp. References ACE_TRACE, ETIME, ACE_OS::gettimeofday(), and owner_. { ACE_TRACE ("ACE_Dev_Poll_Reactor::Token_Guard::acquire"); // Try to grab the token. If someone if already there, don't wake // them up, just queue up in the thread pool. int result = 0; if (max_wait) { ACE_Time_Value tv = ACE_OS::gettimeofday (); tv += *max_wait; ACE_MT (result = this->token_.acquire (0, 0, &tv)); } else { ACE_MT (result = this->token_.acquire ()); } // 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_Dev_Poll_Reactor::Token_Guard::acquire_quietly (  ACE_Time_Value *  max_wait = 0  )

A helper method that acquires the token 1) at a low priority, and 2) wait quietly for the token, not waking another thread. This is appropriate for cases where a thread wants to wait for and dispatch an event, not causing an existing waiter to relinquish the token, and also queueing up behind other threads waiting to modify event records. Definition at line 2574 of file Dev_Poll_Reactor.cpp. References ACE_ERROR, ACE_TRACE, ETIME, ACE_OS::gettimeofday(), LM_ERROR, owner_, and polite_sleep_hook(). Referenced by ACE_Dev_Poll_Reactor::handle_events(), and ACE_Dev_Poll_Reactor::work_pending(). { ACE_TRACE ("ACE_Dev_Poll_Reactor::Token_Guard::acquire_quietly"); // Acquire the token but don't ping any waiters; just queue up politely. int result = 0; if (max_wait) { ACE_Time_Value tv = ACE_OS::gettimeofday (); tv += *max_wait; ACE_MT (result = this->token_.acquire_read (&polite_sleep_hook, 0, &tv)); } else { ACE_MT (result = this->token_.acquire_read (&polite_sleep_hook)); } // Check for timeouts and errors. if (result == -1) { if (errno == ETIME) return 0; else { ACE_ERROR ((LM_ERROR, "%t: %p\n", "token acquire_read")); return -1; } } // We got the token and so let us mark ourselves as owner this->owner_ = 1; return result; }

ACE_INLINE int ACE_Dev_Poll_Reactor::Token_Guard::is_owner (  void   )

Returns whether the thread that created this object owns the token or not. Definition at line 223 of file Dev_Poll_Reactor.inl. References owner_. Referenced by ACE_Dev_Poll_Reactor::handle_events(), and ACE_Dev_Poll_Reactor::work_pending(). { return this->owner_; }

ACE_INLINE void ACE_Dev_Poll_Reactor::Token_Guard::release_token (  void   )

Release the token .. Definition at line 211 of file Dev_Poll_Reactor.inl. References owner_. Referenced by ACE_Dev_Poll_Reactor::dispatch_io_event(), and ACE_Dev_Poll_Reactor::dispatch_timer_handler(). { if (this->owner_) { ACE_MT (this->token_.release ()); // We are not the owner anymore.. this->owner_ = 0; } }

---

Member Data Documentation

int ACE_Dev_Poll_Reactor::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 hasn't got the token (and hence the thread) and a value of 1 vice-versa. Definition at line 1217 of file Dev_Poll_Reactor.h. Referenced by acquire(), acquire_quietly(), is_owner(), release_token(), and ~Token_Guard().

ACE_Dev_Poll_Reactor_Token& ACE_Dev_Poll_Reactor::Token_Guard::token_ [private]

The Reactor token. Definition at line 1211 of file Dev_Poll_Reactor.h.

---

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

• Dev_Poll_Reactor.h
• Dev_Poll_Reactor.cpp
• Dev_Poll_Reactor.inl

---