-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * 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 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2007, 2010 Craig Edwards <brain@inspircd.org>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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
+ * License as published by the Free Software Foundation, version 2.
*
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#ifndef INSPIRCD_TIMER_H
-#define INSPIRCD_TIMER_H
+
+#pragma once
+
+class Module;
/** Timer class for one-second resolution timers
- * InspTimer provides a facility which allows module
+ * Timer 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
+ * 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 InspTimer : public Extensible
+class CoreExport Timer
{
- private:
/** The triggering time
*/
time_t trigger;
+
+ /** Number of seconds between triggers
+ */
+ 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 repeating Repeat this timer every secs_from_now seconds if set to true
*/
- InspTimer(long secs_from_now,time_t now)
- {
- trigger = now + secs_from_now;
- }
- /** Default destructor, does nothing.
+ Timer(unsigned int secs_from_now, bool repeating = false);
+
+ /** Default destructor, removes the timer from the timer manager
*/
- virtual ~InspTimer() { }
+ 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
+ */
+ void SetTrigger(time_t nexttrigger)
+ {
+ 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() const
+ {
+ return repeat;
+ }
+
+ /** Returns the interval (number of seconds between ticks)
+ * of this timer object.
+ */
+ unsigned int GetInterval() const
+ {
+ 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.
+ */
+ void CancelRepeat()
+ {
+ repeat = false;
+ }
+};
-/** This class manages sets of InspTimers, and triggers them at their defined times.
+/** 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 TimerManager : public Extensible
+class CoreExport TimerManager
{
- 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:
+ typedef std::multimap<time_t, Timer*> TimerMap;
- /** The current timer set, a map of timergroups
+ /** A list of all pending timers
*/
- timerlist Timers;
+ TimerMap Timers;
public:
- /** Tick all pending InspTimers
+ /** Tick all pending Timers
* @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
+
+ /** Add an Timer
+ * @param T an Timer derived class to add
*/
- void DelTimer(InspTimer* T);
- /** Tick any timers that have been missed due to lag
- * @param TIME the current system time
+ void AddTimer(Timer *T);
+
+ /** Remove a Timer
+ * @param T an Timer derived class to remove
*/
- void TickMissedTimers(time_t TIME);
+ void DelTimer(Timer* T);
};
-
-#endif
projects / user / henk / code / inspircd.git / blobdiff