ACE 8.0.0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | Protected Attributes | List of all members
ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY > Class Template Reference

Iterates over an ACE_Timer_Heap_T. More...

#include <Timer_Heap_T.h>

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

Public Types

typedef ACE_Timer_Heap_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICYHeap
 

Public Member Functions

 ACE_Timer_Heap_Iterator_T (Heap &)
 Constructor.
 
 ~ACE_Timer_Heap_Iterator_T () override=default
 Destructor.
 
void first () override
 Positions the iterator at the earliest node in the Timer Queue.
 
void next () override
 Positions the iterator at the next node in the Timer Queue.
 
bool isdone () const override
 Returns true when there are no more nodes in the sequence.
 
ACE_Timer_Node_T< TYPE > * item () override
 Returns the node at the current position in the sequence.
 
- Public Member Functions inherited from ACE_Timer_Queue_Iterator_T< TYPE >
 ACE_Timer_Queue_Iterator_T ()=default
 Constructor.
 
virtual ~ACE_Timer_Queue_Iterator_T ()
 Destructor.
 

Public Attributes

 ACE_ALLOC_HOOK_DECLARE
 Declare the dynamic allocation hooks.
 

Protected Attributes

Heaptimer_heap_
 Pointer to the ACE_Timer_Heap that we are iterating over.
 
size_t position_
 Position in the array where the iterator is at.
 

Detailed Description

template<class TYPE, class FUNCTOR, class ACE_LOCK, typename TIME_POLICY = ACE_Default_Time_Policy>
class ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >

Iterates over an ACE_Timer_Heap_T.

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

Member Typedef Documentation

◆ Heap

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
typedef ACE_Timer_Heap_T<TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY> ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::Heap

Constructor & Destructor Documentation

◆ ACE_Timer_Heap_Iterator_T()

Constructor.

◆ ~ACE_Timer_Heap_Iterator_T()

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::~ACE_Timer_Heap_Iterator_T ( )
overridedefault

Destructor.

Member Function Documentation

◆ first()

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
void ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::first ( )
overridevirtual

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

Implements ACE_Timer_Queue_Iterator_T< TYPE >.

◆ isdone()

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
bool ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::isdone ( ) const
overridevirtual

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

Implements ACE_Timer_Queue_Iterator_T< TYPE >.

◆ item()

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
ACE_Timer_Node_T< TYPE > * ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::item ( )
overridevirtual

Returns the node at the current position in the sequence.

Implements ACE_Timer_Queue_Iterator_T< TYPE >.

◆ next()

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY >
void ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::next ( )
overridevirtual

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

Implements ACE_Timer_Queue_Iterator_T< TYPE >.

Member Data Documentation

◆ ACE_ALLOC_HOOK_DECLARE

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

◆ position_

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
size_t ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::position_
protected

Position in the array where the iterator is at.

◆ timer_heap_

template<class TYPE , class FUNCTOR , class ACE_LOCK , typename TIME_POLICY = ACE_Default_Time_Policy>
Heap& ACE_Timer_Heap_Iterator_T< TYPE, FUNCTOR, ACE_LOCK, TIME_POLICY >::timer_heap_
protected

Pointer to the ACE_Timer_Heap that we are iterating over.


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