X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Ftimer.h;h=193e5909b759544573caa898b2832ba68d1a767b;hb=27f8e788c2a515f63f1f0e5e2b4b0d5e78c3dab4;hp=9bb7128b85ac7f6283ec51a0e6986fc7464a6a1d;hpb=def08e968b2ed922d7ee69d92d6754f858d00f57;p=user%2Fhenk%2Fcode%2Finspircd.git

diff --git a/include/timer.h b/include/timer.h
index 9bb7128b8..193e5909b 100644
--- a/include/timer.h
+++ b/include/timer.h
@@ -1,9 +1,14 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2013-2014 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ *   Copyright (C) 2009 Daniel De Graaf <danieldg@inspircd.org>
  *   Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ *   Copyright (C) 2007, 2010 Craig Edwards <brain@inspircd.org>
  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
- *   Copyright (C) 2006-2007 Craig Edwards <craigedwards@brainbox.cc>
  *
  * This file is part of InspIRCd.  InspIRCd is free software: you can
  * redistribute it and/or modify it under the terms of the GNU General Public
@@ -19,8 +24,9 @@
  */
 
 
-#ifndef INSPIRCD_TIMER_H
-#define INSPIRCD_TIMER_H
+#pragma once
+
+class Module;
 
 /** Timer class for one-second resolution timers
  * Timer provides a facility which allows module
@@ -29,61 +35,65 @@
  * 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
+ * your object (which you have to override) will be called
  * at the given time.
  */
 class CoreExport Timer
 {
- private:
 	/** The triggering time
 	 */
 	time_t trigger;
+
 	/** Number of seconds between triggers
 	 */
-	long secs;
+	unsigned int secs;
+
 	/** True if this is a repeating timer
 	 */
 	bool repeat;
+
  public:
 	/** Default constructor, initializes the triggering time
 	 * @param secs_from_now The number of seconds from now to trigger the timer
-	 * @param now The time now
 	 * @param repeating Repeat this timer every secs_from_now seconds if set to true
 	 */
-	Timer(long secs_from_now, time_t now, bool repeating = false)
-	{
-		trigger = now + secs_from_now;
-		secs = secs_from_now;
-		repeat = repeating;
-	}
+	Timer(unsigned int secs_from_now, bool repeating = false);
 
-	/** Default destructor, does nothing.
+	/** Default destructor, removes the timer from the timer manager
 	 */
-	virtual ~Timer() { }
+	virtual ~Timer();
 
 	/** Retrieve the current triggering time
 	 */
-	virtual time_t GetTimer()
+	time_t GetTrigger() const
 	{
 		return trigger;
 	}
 
 	/** Sets the trigger timeout to a new value
+	 * This does not update the bookkeeping in TimerManager, use SetInterval()
+	 * to change the interval between ticks while keeping TimerManager updated
 	 */
-	virtual void SetTimer(time_t t)
+	void SetTrigger(time_t nexttrigger)
 	{
-		trigger = t;
+		trigger = nexttrigger;
 	}
 
+	/** Sets the interval between two ticks.
+	 */
+	void SetInterval(unsigned int interval);
+
 	/** Called when the timer ticks.
 	 * You should override this method with some useful code to
 	 * handle the tick event.
+	 * @param TIME The current time.
+	 * @return True if the Timer object is still valid, false if it was destructed.
 	 */
-	virtual void Tick(time_t TIME) = 0;
+	virtual bool Tick(time_t TIME) = 0;
 
 	/** Returns true if this timer is set to repeat
 	 */
-	bool GetRepeat()
+	bool GetRepeat() const
 	{
 		return repeat;
 	}
@@ -91,7 +101,7 @@ class CoreExport Timer
 	/** Returns the interval (number of seconds between ticks)
 	 * of this timer object.
 	 */
-	long GetSecs()
+	unsigned int GetInterval() const
 	{
 		return secs;
 	}
@@ -99,12 +109,6 @@ class CoreExport Timer
 	/** 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()
 	{
@@ -112,24 +116,19 @@ class CoreExport Timer
 	}
 };
 
-
 /** 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 CoreExport TimerManager
 {
- protected:
+	typedef std::multimap<time_t, Timer*> TimerMap;
+
 	/** A list of all pending timers
 	 */
-	std::vector<Timer *> Timers;
+	TimerMap Timers;
 
  public:
-	/** Constructor
-	 */
-	TimerManager();
-	~TimerManager();
-
 	/** Tick all pending Timers
 	 * @param TIME the current system time
 	 */
@@ -140,15 +139,8 @@ class CoreExport TimerManager
 	 */
 	void AddTimer(Timer *T);
 
-	/** Delete an Timer
-	 * @param T an Timer derived class to delete
+	/** Remove a Timer
+	 * @param T an Timer derived class to remove
 	 */
 	void DelTimer(Timer* T);
-
-	/** Compares two timers
-	 */
-	static bool TimerComparison( Timer *one,  Timer*two);
 };
-
-#endif
-