include/timer.h

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
   5  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
   6  *   Copyright (C) 2006-2007 Craig Edwards <craigedwards@brainbox.cc>
   7  *
   8  * This file is part of InspIRCd.  InspIRCd is free software: you can
   9  * redistribute it and/or modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation, version 2.
  11  *
  12  * This program is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  15  * details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21
  22 #pragma once
  23
  24 class Module;
  25
  26 /** Timer class for one-second resolution timers
  27  * Timer provides a facility which allows module
  28  * developers to create one-shot timers. The timer
  29  * can be made to trigger at any time up to a one-second
  30  * resolution. To use Timer, inherit a class from
  31  * Timer, then insert your inherited class into the
  32  * queue using Server::AddTimer(). The Tick() method of
  33  * your object (which you have to override) will be called
  34  * at the given time.
  35  */
  36 class CoreExport Timer
  37 {
  38         /** The triggering time
  39          */
  40         time_t trigger;
  41
  42         /** Number of seconds between triggers
  43          */
  44         unsigned int secs;
  45
  46         /** True if this is a repeating timer
  47          */
  48         bool repeat;
  49
  50  public:
  51         /** Default constructor, initializes the triggering time
  52          * @param secs_from_now The number of seconds from now to trigger the timer
  53          * @param now The time now
  54          * @param repeating Repeat this timer every secs_from_now seconds if set to true
  55          */
  56         Timer(unsigned int secs_from_now, time_t now, bool repeating = false);
  57
  58         /** Default destructor, removes the timer from the timer manager
  59          */
  60         virtual ~Timer();
  61
  62         /** Retrieve the current triggering time
  63          */
  64         time_t GetTrigger() const
  65         {
  66                 return trigger;
  67         }
  68
  69         /** Sets the trigger timeout to a new value
  70          * This does not update the bookkeeping in TimerManager, use SetInterval()
  71          * to change the interval between ticks while keeping TimerManager updated
  72          */
  73         void SetTrigger(time_t nexttrigger)
  74         {
  75                 trigger = nexttrigger;
  76         }
  77
  78         /** Sets the interval between two ticks.
  79          */
  80         void SetInterval(time_t interval);
  81
  82         /** Called when the timer ticks.
  83          * You should override this method with some useful code to
  84          * handle the tick event.
  85          * @param TIME The current time.
  86          * @return True if the Timer object is still valid, false if it was destructed.
  87          */
  88         virtual bool Tick(time_t TIME) = 0;
  89
  90         /** Returns true if this timer is set to repeat
  91          */
  92         bool GetRepeat() const
  93         {
  94                 return repeat;
  95         }
  96
  97         /** Returns the interval (number of seconds between ticks)
  98          * of this timer object.
  99          */
 100         unsigned int GetInterval() const
 101         {
 102                 return secs;
 103         }
 104
 105         /** Cancels the repeat state of a repeating timer.
 106          * If you call this method, then the next time your
 107          * timer ticks, it will be removed immediately after.
 108          */
 109         void CancelRepeat()
 110         {
 111                 repeat = false;
 112         }
 113 };
 114
 115 typedef std::multimap<time_t, Timer*> TimerMap;
 116
 117 /** This class manages sets of Timers, and triggers them at their defined times.
 118  * This will ensure timers are not missed, as well as removing timers that have
 119  * expired and allowing the addition of new ones.
 120  */
 121 class CoreExport TimerManager
 122 {
 123         /** A list of all pending timers
 124          */
 125         TimerMap Timers;
 126
 127  public:
 128         /** Tick all pending Timers
 129          * @param TIME the current system time
 130          */
 131         void TickTimers(time_t TIME);
 132
 133         /** Add an Timer
 134          * @param T an Timer derived class to add
 135          */
 136         void AddTimer(Timer *T);
 137
 138         /** Remove a Timer
 139          * @param T an Timer derived class to remove
 140          */
 141         void DelTimer(Timer* T);
 142 };