diff options
author | schmidt <douglascraigschmidt@users.noreply.github.com> | 1997-04-26 18:48:06 +0000 |
---|---|---|
committer | schmidt <douglascraigschmidt@users.noreply.github.com> | 1997-04-26 18:48:06 +0000 |
commit | db6aeae3d09f810f1529c0bfe6ad6cfe0dc0630f (patch) | |
tree | 7e7bb5e43b96de401923fd3319b9800d586dd78a /ace/Timer_List.h | |
parent | 1096fb8639512ab1aacbedf3a2a55b699ade132b (diff) | |
download | ATCD-db6aeae3d09f810f1529c0bfe6ad6cfe0dc0630f.tar.gz |
*** empty log message ***
Diffstat (limited to 'ace/Timer_List.h')
-rw-r--r-- | ace/Timer_List.h | 161 |
1 files changed, 7 insertions, 154 deletions
diff --git a/ace/Timer_List.h b/ace/Timer_List.h index 8dd1040aa0f..cd5e8c0f751 100644 --- a/ace/Timer_List.h +++ b/ace/Timer_List.h @@ -17,162 +17,15 @@ #if !defined (ACE_TIMER_LIST_H) #define ACE_TIMER_LIST_H -#include "ace/Timer_Queue.h" +#include "ace/Timer_List_T.h" -// Forward declaration. -template <class TYPE, class FUNCTOR> -class ACE_Timer_List_T; +// The following typedef are here for ease of use and backward +// compatibility. -template <class TYPE, class FUNCTOR> -class ACE_Timer_List_Iterator_T : public ACE_Timer_Queue_Iterator_T <TYPE, FUNCTOR> - // = TITLE - // Iterates over an <ACE_Timer_Queue>. - // - // = DESCRIPTION - // This is a special type of iterator that "advances" by moving - // the head of the timer queue up by one every time. -{ -public: - ACE_Timer_List_Iterator_T (ACE_Timer_List_T<TYPE, FUNCTOR> &); - // Constructor. +typedef ACE_Timer_List_T<ACE_Event_Handler *, ACE_Event_Handler_Handle_Timeout_Upcall> + ACE_Timer_List; - virtual int next (NODE *&timer_node, - const ACE_Time_Value &cur_time); - // Pass back the next <timer_node> that hasn't been seen yet, if its - // <time_value_> <= <cur_time>. In addition, moves the timer queue - // forward by one node. Returns 0 when all <timer_nodes> have been - // seen, else 1. - -protected: - ACE_Timer_List_T<TYPE, FUNCTOR> &timer_list_; - // Pointer to the <ACE_Timer_List> that we are iterating over. -}; - -template <class TYPE, class FUNCTOR> -class ACE_Timer_List_T : public ACE_Timer_Queue_T<TYPE, FUNCTOR> - // = TITLE - // Provides a simple implementation of timers. - // - // = DESCRIPTION - // - // This implementation uses a linked list of absolute times. - // Therefore, in the average case, scheduling and canceling - // timers is O(N) (where N is the total number of timers) and - // expiring timers is O(K) (where K is the total number of timers - // that are < the current time of day). - // - // More clever implementations could use a delta-list, a heap, - // or timing wheels, etc. For instance, <ACE_Timer_Heap> - // is a subclass of <ACE_Timer_List> that implements a - // heap-based callout queue. For most applications, the - // <ACE_Timer_Heap> will perform substantially faster than the - // <ACE_Timer_List>. -{ -public: - typedef ACE_Timer_List_Iterator_T<TYPE, FUNCTOR> LIST_ITERATOR; - // Type of iterator - - friend LIST_ITERATOR; - // Iterator is a friend - - typedef ACE_Timer_Queue_T<TYPE, FUNCTOR> INHERITED; - // Type inherited from - - // = Initialization and termination methods. - ACE_Timer_List_T (FUNCTOR *upcall_functor = 0); - // Default constructor. <upcall_functor> is the instance of the - // FUNCTOR to be used by the list. If <upcall_functor> is 0, a - // default FUNCTOR will be created. - - virtual ~ACE_Timer_List_T (void); - // Destructor - - virtual int is_empty (void) const; - // True if queue is empty, else false. - - virtual const ACE_Time_Value &earliest_time (void) const; - // Returns the time of the earlier node in the <ACE_Timer_List>. - - virtual int schedule (const TYPE &type, - const void *act, - const ACE_Time_Value &delay, - const ACE_Time_Value &interval = ACE_Time_Value::zero); - // Schedule <type> that will expire after <delay> amount of time. - // If it expires then <act> is passed in as the value to the - // <functor>. If <interval> is != to <ACE_Time_Value::zero> then it - // is used to reschedule the <type> automatically. This method - // returns a <timer_id> that uniquely identifies the the <type> - // entry in an internal list. This <timer_id> can be used to cancel - // the timer before it expires. The cancellation ensures that - // <timer_ids> are unique up to values of greater than 2 billion - // timers. As long as timers don't stay around longer than this - // there should be no problems with accidentally deleting the wrong - // timer. Returns -1 on failure (which is guaranteed never to be a - // valid <timer_id>). - - virtual int cancel (const TYPE &type, - int dont_call_handle_close = 1); - // Cancel all timer associated with <type>. If <dont_call> is 0 - // then the <functor> will be invoked. Returns number of timers - // cancelled. - - virtual int cancel (int timer_id, - const void **act = 0, - int dont_call_handle_close = 1); - // Cancel the single timer that matches the <timer_id> value (which - // was returned from the <schedule> method). If act is non-NULL - // then it will be set to point to the ``magic cookie'' argument - // passed in when the timer was registered. This makes it possible - // to free up the memory and avoid memory leaks. If <dont_call> is - // 0 then the <functor> will be invoked. Returns 1 if cancellation - // succeeded and 0 if the <timer_id> wasn't found. - - virtual void dump (void) const; - // Dump the state of an object. - -protected: - virtual NODE *alloc_node (void); - // Factory method that allocates a new node (uses operator new). - - virtual void free_node (NODE *); - // Factory method that frees a previously allocated node (uses - // operator delete). - -private: - int timer_id (void); - // Returns a timer id that uniquely identifies this timer. This id - // can be used to cancel a timer via the <cancel (int)> method. The - // timer id returned from this method will never == -1 to avoid - // conflicts with other failure return values. - - virtual void reschedule (NODE *); - // Reschedule an "interval" <ACE_Timer_Node>. - - virtual ITERATOR &iter (void); - // Returns a pointer to this <ACE_Timer_Queue>'s iterator. - - NODE *head_; - // Pointer to linked list of <ACE_Timer_Handles>. - - LIST_ITERATOR iterator_; - // Iterator used to expire timers. - - int timer_id_; - // Keeps track of the timer id that uniquely identifies each timer. - // This id can be used to cancel a timer via the <cancel (int)> - // method. - - // = Don't allow these operations for now. - ACE_Timer_List_T (const ACE_Timer_List_T<TYPE, FUNCTOR> &); - void operator= (const ACE_Timer_List_T<TYPE, FUNCTOR> &); -}; - -#if defined (ACE_TEMPLATES_REQUIRE_SOURCE) -#include "ace/Timer_List.cpp" -#endif /* ACE_TEMPLATES_REQUIRE_SOURCE */ - -#if defined (ACE_TEMPLATES_REQUIRE_PRAGMA) -#pragma implementation ("Timer_List.cpp") -#endif /* ACE_TEMPLATES_REQUIRE_PRAGMA */ +typedef ACE_Timer_List_Iterator_T<ACE_Event_Handler *, ACE_Event_Handler_Handle_Timeout_Upcall> + ACE_Timer_List_Iterator; #endif /* ACE_TIMER_LIST_H */ |