## NAME

ACE_Timer_Heap_Iterator_T - Iterates over an `ACE_Timer_Heap_T`.

## SYNOPSIS

    #include <ace/Timer_Heap_T.h>

    template<class TYPE, class FUNCTOR, class ACE_LOCK>
    class ACE_Timer_Heap_Iterator_T :
      public ACE_Timer_Queue_Iterator_T<TYPE, FUNCTOR, ACE_LOCK>
    {
      public:
        ACE_Timer_Heap_Iterator_T (
            ACE_Timer_Heap_T<TYPE, FUNCTOR, ACE_LOCK> &
            );
        ~ACE_Timer_Heap_Iterator_T (void);
        virtual void first (void);
        virtual void next (void);
        virtual int isdone (void);
        virtual ACE_Timer_Node_T<TYPE> *item (void);
      protected:
        ACE_Timer_Heap_T<TYPE, FUNCTOR, ACE_LOCK> &timer_heap_;
        size_t position_;
    };

## DESCRIPTION

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.

## PUBLIC MEMBERS

    ACE_Timer_Heap_Iterator_T (
        ACE_Timer_Heap_T<TYPE, FUNCTOR, ACE_LOCK> &
        );

Constructor.

    ~ACE_Timer_Heap_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);

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 MEMBERS

    ACE_Timer_Heap_T<TYPE, FUNCTOR, ACE_LOCK> &timer_heap_;

Pointer to the `ACE_Timer_Heap` that we are iterating over.

    size_t position_;

Position in the array where the iterator is at

## AUTHOR

Doug Schmidt

## LIBRARY

ace