Roadmap item "Fix jointhrottle to not try 'throttle' clients during a netmerge (requi...

[user/henk/code/inspircd.git] / include / timer.h

diff --git a/include/timer.h b/include/timer.h
index f8e2bdcdf8884d89dd6708d8ef9ccdcb81fe1486..82c788242093ffd5f4c7abc3c3e6bb54d599d5d2 100644 (file)
--- a/include/timer.h
+++ b/include/timer.h
@@ -14,23 +14,29 @@
 #ifndef INSPIRCD_TIMER_H
 #define INSPIRCD_TIMER_H
 
+class InspIRCd;
+
 /** Timer class for one-second resolution timers
- * InspTimer provides a facility which allows module
+ * Timer provides a facility which allows module
  * developers to create one-shot timers. The timer
  * can be made to trigger at any time up to a one-second
- * resolution. To use InspTimer, inherit a class from
- * InspTimer, then insert your inherited class into the
+ * resolution. To use Timer, inherit a class from
+ * Timer, then insert your inherited class into the
  * queue using Server::AddTimer(). The Tick() method of
  * your object (which you should override) will be called
  * at the given time.
  */
-class InspTimer : public Extensible
+class CoreExport Timer : public Extensible
 {
  private:
        /** The triggering time
         */
        time_t trigger;
+       /** Number of seconds between triggers
+        */
        long secs;
+       /** True if this is a repeating timer
+        */
        bool repeat;
  public:
        /** Default constructor, initializes the triggering time
@@ -38,51 +44,81 @@ class InspTimer : public Extensible
         * @param now The time now
         * @param repeating Repeat this timer every secs_from_now seconds if set to true
         */
-       InspTimer(long secs_from_now,time_t now, bool repeating = false)
+       Timer(long secs_from_now,time_t now, bool repeating = false)
        {
                trigger = now + secs_from_now;
                secs = secs_from_now;
                repeat = repeating;
        }
+
        /** Default destructor, does nothing.
         */
-       virtual ~InspTimer() { }
+       virtual ~Timer() { }
+
        /** Retrieve the current triggering time
         */
        virtual time_t GetTimer()
        {
                return trigger;
        }
+
        /** Called when the timer ticks.
+        * You should override this method with some useful code to
+        * handle the tick event.
         */
        virtual void Tick(time_t TIME) = 0;
 
+       /** Returns true if this timer is set to repeat
+        */
        bool GetRepeat()
        {
                return repeat;
        }
 
+       /** Returns the interval (number of seconds between ticks)
+        * of this timer object.
+        */
        long GetSecs()
        {
                return secs;
        }
+
+       /** Cancels the repeat state of a repeating timer.
+        * If you call this method, then the next time your
+        * timer ticks, it will be removed immediately after.
+        * You should use this method call to remove a recurring
+        * timer if you wish to do so within the timer's Tick
+        * event, as calling TimerManager::DelTimer() from within
+        * the Timer::Tick() method is dangerous and may
+        * cause a segmentation fault. Calling CancelRepeat()
+        * is safe in this case.
+        */
+       void CancelRepeat()
+       {
+               repeat = false;
+       }
 };
 
 
-/** This class manages sets of InspTimers, and triggers them at their defined times.
+/** This class manages sets of Timers, and triggers them at their defined times.
  * This will ensure timers are not missed, as well as removing timers that have
  * expired and allowing the addition of new ones.
  */
-class TimerManager : public Extensible
+class CoreExport TimerManager : public Extensible
 {
  protected:
        /** A group of timers all set to trigger at the same time
         */
-       typedef std::vector<InspTimer*> timergroup;
+       typedef std::vector<Timer*> timergroup;
        /** A map of timergroups, each group has a specific trigger time
         */
        typedef std::map<time_t, timergroup*> timerlist;
-
+       /** Set when ticking timers, to prevent deletion while iterating
+        */
+       bool CantDeleteHere;
+       /** Creating server instance
+        */
+       InspIRCd* ServerInstance;
  private:
 
        /** The current timer set, a map of timergroups
@@ -90,23 +126,26 @@ class TimerManager : public Extensible
        timerlist Timers;
 
  public:
-       /** Tick all pending InspTimers
+       /** Constructor
+        */
+       TimerManager(InspIRCd* Instance);
+       /** Tick all pending Timers
         * @param TIME the current system time
         */
        void TickTimers(time_t TIME);
-       /** Add an InspTimer
-        * @param T an InspTimer derived class to add
+       /** Add an Timer
+        * @param T an Timer derived class to add
         * @param secs_from_now You may set this to the number of seconds
         * from the current time when the timer will tick, or you may just
-        * leave this unset and the values set by the InspTimers constructor
+        * leave this unset and the values set by the Timers constructor
         * will be used. This is used internally for re-triggering repeating
         * timers.
         */
-       void AddTimer(InspTimer* T, long secs_from_now = 0);
-       /** Delete an InspTimer
-        * @param T an InspTimer derived class to delete
+       void AddTimer(Timer* T, long secs_from_now = 0);
+       /** Delete an Timer
+        * @param T an Timer derived class to delete
         */
-       void DelTimer(InspTimer* T);
+       void DelTimer(Timer* T);
        /** Tick any timers that have been missed due to lag
         * @param TIME the current system time
         */
@@ -114,3 +153,4 @@ class TimerManager : public Extensible
 };
 
 #endif
+