Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK > Class Template Reference

Iterates over an ACE_Timer_Wheel. More...

#include <Timer_Wheel_T.h>

Inheritance diagram for ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >:

Inheritance graph
[legend]
Collaboration diagram for ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ACE_Timer_Wheel_T<
TYPE, FUNCTOR, ACE_LOCK > 		Wheel
typedef ACE_Timer_Node_T<
TYPE > 		Node

Public Member Functions

 ACE_Timer_Wheel_Iterator_T (Wheel &)
 Constructor.

 ~ACE_Timer_Wheel_Iterator_T (void)
 Destructor.

virtual void first (void)
 Positions the iterator at the earliest node in the Timer Queue.

virtual void next (void)
 Positions the iterator at the next node in the Timer Queue.

virtual int isdone (void) const
 Returns true when there are no more nodes in the sequence.

virtual ACE_Timer_Node_T<
TYPE > * 		item (void)
 Returns the node at the current position in the sequence.


Protected Attributes

Wheel & timer_wheel_
 Pointer to the ACE_Timer_List that we are iterating over.

u_int spoke_
 Current position in the timing wheel.

ACE_Timer_Node_T< TYPE > * current_node_
 Pointer to the position in the the th list.


Private Member Functions

void goto_next (u_int start_spoke)
 Helper class for common functionality of next() and first().

Detailed Description

template<class TYPE, class FUNCTOR, class ACE_LOCK>
class ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >

Iterates over an ACE_Timer_Wheel.

This is a generic iterator that can be used to visit every node of a timer queue. Be aware that it doesn't traverse in the order of timeout values.

Definition at line 39 of file Timer_Wheel_T.h.

Member Typedef Documentation

template<class TYPE, class FUNCTOR, class ACE_LOCK>
typedef ACE_Timer_Node_T<TYPE> ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::Node
 

Definition at line 44 of file Timer_Wheel_T.h.

template<class TYPE, class FUNCTOR, class ACE_LOCK>
typedef ACE_Timer_Wheel_T<TYPE, FUNCTOR, ACE_LOCK> ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::Wheel
 

Definition at line 43 of file Timer_Wheel_T.h.

Referenced by ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::ACE_Timer_Wheel_Iterator_T().

Constructor & Destructor Documentation

template<class TYPE, class FUNCTOR, class ACE_LOCK>
ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::ACE_Timer_Wheel_Iterator_T (  Wheel &  wheel  ) 
 

Constructor.

Just initializes the iterator with a ACE_Timer_Wheel_T and then calls first() to initialize the rest of itself.

Parameters:
wheel A reference for a timer queue to iterate over

Definition at line 871 of file Timer_Wheel_T.cpp.

References ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::Wheel. 

00872 : timer_wheel_ (wheel)
00873 {
00874   this->first();
00875 }

template<class TYPE, class FUNCTOR, class ACE_LOCK>
ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::~ACE_Timer_Wheel_Iterator_T (  void   ) 
 

Destructor.

Destructor, at this level does nothing.

Definition at line 884 of file Timer_Wheel_T.cpp. 

00885 {
00886 }

Member Function Documentation

template<class TYPE, class FUNCTOR, class ACE_LOCK>
void ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::first (  void   )  [virtual]
 

Positions the iterator at the earliest node in the Timer Queue.

Positions the iterator at the first position in the timing wheel that contains something. spoke_ will be set to the spoke position of this entry and current_node_ will point to the first entry in that spoke.

If the wheel is empty, spoke_ will be equal timer_wheel_.spoke_count_ and current_node_ would be 0.

Implements ACE_Timer_Queue_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >.

Definition at line 898 of file Timer_Wheel_T.cpp.

References ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::goto_next(). 

00899 {
00900   this->goto_next(0);
00901 }

template<class TYPE, class FUNCTOR, class ACE_LOCK>
void ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::goto_next (  u_int  start_spoke  )  [private]
 

Helper class for common functionality of next() and first().

Definition at line 923 of file Timer_Wheel_T.cpp.

References ACE_Timer_Node_T< TYPE >::get_next(), ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::spoke_, ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK >::spoke_count_, ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK >::spokes_, and ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::timer_wheel_.

Referenced by ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::first(), and ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::next(). 

00924 {
00925   // Find the first non-empty entry.
00926   u_int sc = this->timer_wheel_.spoke_count_;
00927   for (u_int i = start_spoke; i < sc; ++i)
00928   {
00929     ACE_Timer_Node_T<TYPE>* root = this->timer_wheel_.spokes_[i];
00930     ACE_Timer_Node_T<TYPE>* n = root->get_next ();
00931     if (n != root)
00932       {
00933         this->spoke_ = i;
00934         this->current_node_ = n;
00935         return;
00936       }
00937   }
00938   // empty
00939   this->spoke_ = sc;
00940   this->current_node_ = 0;
00941 }

template<class TYPE, class FUNCTOR, class ACE_LOCK>
int ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::isdone (  void   )  const [virtual]
 

Returns true when there are no more nodes in the sequence.

Returns:
True when we there aren't any more items (when current_node_ == 0)

Implements ACE_Timer_Queue_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >.

Definition at line 947 of file Timer_Wheel_T.cpp.

Referenced by ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::next(). 

00948 {
00949   return this->current_node_ == 0;
00950 }

template<class TYPE, class FUNCTOR, class ACE_LOCK>
ACE_Timer_Node_T< TYPE > * ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::item (  void   )  [virtual]
 

Returns the node at the current position in the sequence.

Returns:
The node at the current spokeition in the sequence or 0 if the wheel is empty

Implements ACE_Timer_Queue_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >.

Definition at line 957 of file Timer_Wheel_T.cpp. 

00958 {
00959   return this->current_node_;
00960 }

template<class TYPE, class FUNCTOR, class ACE_LOCK>
void ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::next (  void   )  [virtual]
 

Positions the iterator at the next node in the Timer Queue.

Positions the iterator at the next node.

Implements ACE_Timer_Queue_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >.

Definition at line 908 of file Timer_Wheel_T.cpp.

References ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::goto_next(), ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::isdone(), ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::spoke_, ACE_Timer_Wheel_T< TYPE, FUNCTOR, ACE_LOCK >::spokes_, and ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::timer_wheel_. 

00909 {
00910   if (this->isdone())
00911     return;
00912 
00913   ACE_Timer_Node_T<TYPE>* n = this->current_node_->get_next ();
00914   ACE_Timer_Node_T<TYPE>* root = this->timer_wheel_.spokes_[this->spoke_];
00915   if (n == root)
00916     this->goto_next (this->spoke_ + 1);
00917   else
00918     this->current_node_ = n;
00919 }

Member Data Documentation

template<class TYPE, class FUNCTOR, class ACE_LOCK>
ACE_Timer_Node_T<TYPE>* ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::current_node_ [protected]
 

Pointer to the position in the the th list.

Definition at line 72 of file Timer_Wheel_T.h.

template<class TYPE, class FUNCTOR, class ACE_LOCK>
u_int ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::spoke_ [protected]
 

Current position in the timing wheel.

Definition at line 69 of file Timer_Wheel_T.h.

Referenced by ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::goto_next(), and ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::next().

template<class TYPE, class FUNCTOR, class ACE_LOCK>
Wheel& ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::timer_wheel_ [protected]
 

Pointer to the ACE_Timer_List that we are iterating over.

Definition at line 66 of file Timer_Wheel_T.h.

Referenced by ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::goto_next(), and ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::next().

The documentation for this class was generated from the following files:
Generated on Sun Jan 27 12:58:59 2008 for ACE by doxygen 1.3.6