ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK > Class Template Reference
Iterates over an ACE_Timer_Wheel. More...
#include <Timer_Wheel_T.h>
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 bool | 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 <pos_>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.
Member Typedef Documentation
| typedef ACE_Timer_Wheel_T<TYPE, FUNCTOR, ACE_LOCK> ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::Wheel |
| typedef ACE_Timer_Node_T<TYPE> ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::Node |
Constructor & Destructor Documentation
| ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::ACE_Timer_Wheel_Iterator_T | ( | Wheel & | wheel | ) | [inline] |
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
| ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::~ACE_Timer_Wheel_Iterator_T | ( | void | ) | [inline] |
Destructor.
Destructor, at this level does nothing.
Member Function Documentation
| void ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::first | ( | void | ) | [inline, 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 >.
| void ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::next | ( | void | ) | [inline, 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 >.
| bool ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::isdone | ( | void | ) | const [inline, 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 >.
| ACE_Timer_Node_T< TYPE > * ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::item | ( | void | ) | [inline, 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 >.
| void ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::goto_next | ( | u_int | start_spoke | ) | [inline, private] |
Member Data Documentation
Wheel& ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::timer_wheel_ [protected] |
Pointer to the ACE_Timer_List that we are iterating over.
u_int ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::spoke_ [protected] |
Current position in the timing wheel.
ACE_Timer_Node_T<TYPE>* ACE_Timer_Wheel_Iterator_T< TYPE, FUNCTOR, ACE_LOCK >::current_node_ [protected] |
Pointer to the position in the the <pos_>th list.
The documentation for this class was generated from the following files:
