X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Ftimer.h;h=da8e742d9f58442c8fd8761be1502b50f5577410;hb=5e9a6b9186a8cbaaf65ae7d9cd9c0c033c91b497;hp=1538fbfb15a7d41670afcf6717c76c87aeeeac5e;hpb=8c2bd7cc635ce14750729455284e4f76fb9fd920;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/timer.h b/include/timer.h
index 1538fbfb1..da8e742d9 100644
--- a/include/timer.h
+++ b/include/timer.h
@@ -2,37 +2,93 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- *                       E-mail:
- *                <brain@chatspike.net>
- *                <Craig@chatspike.net>
+ *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
+ * See: http://www.inspircd.org/wiki/index.php/Credits
  *
- * Written by Craig Edwards, Craig McLure, and others.
  * This program is free but copyrighted software; see
  *            the file COPYING for details.
  *
  * ---------------------------------------------------
  */
 
-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);
 
+/** 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