Remove an utterly insane comment .. based on changed by based on originally by change...

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

diff --git a/include/timer.h b/include/timer.h
index 9820be2fbd0887a50c4881a538fbe4c0e0d1888e..ef8b82e31f64d728d662c35769af20842e162a9a 100644 (file)
--- a/include/timer.h
+++ b/include/timer.h
@@ -14,6 +14,8 @@
 #ifndef INSPIRCD_TIMER_H
 #define INSPIRCD_TIMER_H
 
+class InspIRCd;
+
 /** Timer class for one-second resolution timers
  * InspTimer provides a facility which allows module
  * developers to create one-shot timers. The timer
@@ -24,13 +26,17 @@
  * your object (which you should override) will be called
  * at the given time.
  */
-class InspTimer : public Extensible
+class CoreExport InspTimer : 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
@@ -44,29 +50,49 @@ class InspTimer : public Extensible
                secs = secs_from_now;
                repeat = repeating;
        }
+
        /** Default destructor, does nothing.
         */
        virtual ~InspTimer() { }
+
        /** 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 InspTimer::Tick() method is dangerous and may
+        * cause a segmentation fault. Calling CancelRepeat()
+        * is safe in this case.
+        */
        void CancelRepeat()
        {
                repeat = false;
@@ -78,7 +104,7 @@ class InspTimer : public Extensible
  * 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
@@ -87,7 +113,12 @@ class TimerManager : public Extensible
        /** 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
@@ -95,6 +126,9 @@ class TimerManager : public Extensible
        timerlist Timers;
 
  public:
+       /** Constructor
+        */
+       TimerManager(InspIRCd* Instance);
        /** Tick all pending InspTimers
         * @param TIME the current system time
         */
@@ -119,3 +153,4 @@ class TimerManager : public Extensible
 };
 
 #endif
+