otk/timerqueuemanager.hh

   1 // -*- mode: C++; indent-tabs-mode: nil; -*-
   2 #ifndef __timerqueuemanager_hh
   3 #define __timerqueuemanager_hh
   4
   5 #include "timerqueue.hh"
   6
   7 namespace otk {
   8
   9 //! Manages a queue of OBTimer objects
  10 /*!
  11   All OBTimer objects add themself to an OBTimerQueueManager. The manager is
  12   what fires the timers when their time has elapsed. This is done by having the
  13   application call the OBTimerQueueManager::fire class in its main event loop.
  14 */
  15 class OBTimerQueueManager {
  16 private:
  17   //! A priority queue of all timers being managed by this class.
  18   TimerQueue timerList;
  19 public:
  20   //! Constructs a new OBTimerQueueManager
  21   OBTimerQueueManager() {}
  22   //! Destroys the OBTimerQueueManager
  23   virtual ~OBTimerQueueManager() {}
  24
  25   //! Will wait for and fire the next timer in the queue.
  26   /*!
  27     The function will stop waiting if an event is received from the X server.
  28   */
  29   virtual void fire();
  30
  31   //! Adds a new timer to the queue
  32   /*!
  33     @param timer An OBTimer to add to the queue
  34   */
  35   virtual void addTimer(OBTimer* timer);
  36   //! Removes a timer from the queue
  37   /*!
  38     @param timer An OBTimer already in the queue to remove
  39   */
  40   virtual void removeTimer(OBTimer* timer);
  41 };
  42
  43 }
  44
  45 #endif // __timerqueuemanager_hh