Alter SetModeParam to take const char* to save on casts, notice a load of modules...

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

diff --git a/include/timer.h b/include/timer.h
index b75f3776f7a2bf16967635a04d72cf493207f2b9..6a4c9063b7316c92cdf046930c898b884b24a5b6 100644 (file)
--- a/include/timer.h
+++ b/include/timer.h
@@ -14,26 +14,48 @@
  * ---------------------------------------------------
  */
 
+#ifndef INSPIRCD_TIMER_H
+#define INSPIRCD_TIMER_H
+
+/** Timer class for one-second resolution timers
+ * InspTimer 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
+ * queue using Server::AddTimer(). The Tick() method of
+ * your object (which you should override) will be called
+ * at the given time.
+ */
 class InspTimer
 {
  private:
+       /** The triggering time
+        */
        time_t trigger;
  public:
+       /** Default constructor, initializes the triggering time
+        */
        InspTimer(long secs_from_now,time_t now)
        {
                trigger = now + secs_from_now;
        }
+       /** Default destructor, does nothing.
+        */
        virtual ~InspTimer() { }
+       /** Retrieve the current triggering time
+        */
        virtual time_t GetTimer()
        {
                return trigger;
        }
-       virtual void Tick(time_t TIME)
-       {
-       }
+       /** Called when the timer ticks.
+        */
+       virtual void Tick(time_t TIME) = 0;
 };
 
 void TickTimers(time_t TIME);
 void AddTimer(InspTimer* T);
 void TickMissedTimers(time_t TIME);
 
+#endif