diff options
Diffstat (limited to 'ace/Timer_List.h')
| -rw-r--r-- | ace/Timer_List.h | 159 |
1 files changed, 0 insertions, 159 deletions
diff --git a/ace/Timer_List.h b/ace/Timer_List.h deleted file mode 100644 index 95b4157d215..00000000000 --- a/ace/Timer_List.h +++ /dev/null @@ -1,159 +0,0 @@ -/* -*- C++ -*- */ -// $Id$ - -// ============================================================================ -// -// = LIBRARY -// ace -// -// = FILENAME -// Timer_List.h -// -// = AUTHOR -// Doug Schmidt -// -// ============================================================================ - -#if !defined (ACE_TIMER_LIST_H) -#define ACE_TIMER_LIST_H - -#include "ace/Timer_Queue.h" - -// Forward declaration -class ACE_Timer_List; - -class ACE_Export ACE_Timer_List_Iterator : public ACE_Timer_Queue_Iterator - // = 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 (ACE_Timer_List &); - // Constructor. - - virtual int next (ACE_Timer_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 &timer_list_; - // Pointer to the <ACE_Timer_List> that we are iterating over. -}; - -class ACE_Export ACE_Timer_List : public ACE_Timer_Queue - // = 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 - // <ACE_Event_Handler> 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>. -{ - friend class ACE_Timer_List_Iterator; -public: - // = Initialization and termination methods. - ACE_Timer_List (void); - // Default constructor. - - virtual ~ACE_Timer_List (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 (ACE_Event_Handler *event_handler, - const void *arg, - const ACE_Time_Value &delay, - const ACE_Time_Value &interval = ACE_Time_Value::zero); - // Schedule an <event_handler> that will expire after <delay> amount - // of time. If it expires then <arg> is passed in as the value to - // the <event_handler>'s <handle_timeout> callback method. If - // <interval> is != to <ACE_Time_Value::zero> then it is used to - // reschedule the <event_handler> automatically. This method - // returns a <timer_id> that uniquely identifies the <event_handler> - // in an internal list. This <timer_id> can be used to cancel an - // <event_handler> 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 (ACE_Event_Handler *event_handler, - int dont_call_handle_close = 1); - // Cancel all <event_handlers> that match the address of - // <event_handler>. If <dont_call_handle_close> is 0 then the - // <handle_close> method of <event_handler> will be invoked. - // Returns number of handler's cancelled. - - virtual int cancel (int timer_id, - const void **arg = 0, - int dont_call_handle_close = 1); - // Cancel the single <ACE_Event_Handler> that matches the <timer_id> - // value (which was returned from the <schedule> method). If arg is - // non-NULL then it will be set to point to the ``magic cookie'' - // argument passed in when the <Event_Handler> was registered. This - // makes it possible to free up the memory and avoid memory leaks. - // 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 ACE_Timer_Node *alloc_node (void); - // Factory method that allocates a new node (uses operator new). - - virtual void free_node (ACE_Timer_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 (ACE_Timer_Node *); - // Reschedule an "interval" <ACE_Timer_Node>. - - virtual ACE_Timer_Queue_Iterator &iter (void); - // Returns a pointer to this <ACE_Timer_Queue>'s iterator. - - ACE_Timer_Node *head_; - // Pointer to linked list of <ACE_Timer_Handles>. - - ACE_Timer_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 (const ACE_Timer_List &); - void operator= (const ACE_Timer_List &); -}; - -#endif /* ACE_TIMER_LIST_H */ |