Add irc::portparser, a class to parse port ranges in the form "6660,6661,6662-6669...

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

diff --git a/include/timer.h b/include/timer.h
index b75f3776f7a2bf16967635a04d72cf493207f2b9..5c899f059a9c6bc2b259a2e1e5c7493911e345ae 100644 (file)
--- a/include/timer.h
+++ b/include/timer.h
@@ -14,26 +14,84 @@
  * ---------------------------------------------------
  */
 
-class InspTimer
+#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 : public Extensible
 {
  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);
 
+/** This class manages sets of InspTimers, 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
+{
+ protected:
+       /** A group of timers all set to trigger at the same time
+        */
+       typedef std::vector<InspTimer*> timergroup;
+       /** A map of timergroups, each group has a specific trigger time
+        */
+       typedef std::map<time_t, timergroup*> timerlist;
+
+ private:
+
+       /** The current timer set, a map of timergroups
+        */
+       timerlist Timers;
+
+ public:
+       /** Tick all pending InspTimers
+        * @param TIME the current system time
+        */
+       void TickTimers(time_t TIME);
+       /** Add an InspTimer
+        * @param T an InspTimer derived class to add
+        */
+       void AddTimer(InspTimer* T);
+       /** Delete an InspTimer
+        * @param T an InspTimer derived class to delete
+        */
+       void DelTimer(InspTimer* T);
+       /** Tick any timers that have been missed due to lag
+        * @param TIME the current system time
+        */
+       void TickMissedTimers(time_t TIME);
+};
+
+#endif