-/* +------------------------------------+
- * | 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) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006-2007 Craig Edwards <craigedwards@brainbox.cc>
*
- * 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
-class InspIRCd;
-
/** 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
* at the given time.
*/
-class InspTimer : public Extensible
+class CoreExport Timer
{
private:
/** The triggering time
* @param now The time now
* @param repeating Repeat this timer every secs_from_now seconds if set to true
*/
- InspTimer(long secs_from_now,time_t now, bool repeating = false)
+ Timer(long secs_from_now, time_t now, bool repeating = false)
{
trigger = now + secs_from_now;
secs = secs_from_now;
/** Default destructor, does nothing.
*/
- virtual ~InspTimer() { }
+ virtual ~Timer() { }
/** Retrieve the current triggering time
*/
return trigger;
}
+ /** Sets the trigger timeout to a new value
+ */
+ virtual void SetTimer(time_t t)
+ {
+ trigger = t;
+ }
+
/** Called when the timer ticks.
* You should override this method with some useful code to
* handle the tick event.
* 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 InspTimer::Tick() method is dangerous and may
+ * the Timer::Tick() method is dangerous and may
* cause a segmentation fault. Calling CancelRepeat()
* is safe in this case.
*/
};
-/** 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;
- /** Set when ticking timers, to prevent deletion while iterating
+ /** A list of all pending timers
*/
- bool CantDeleteHere;
- /** Creating server instance
- */
- InspIRCd* ServerInstance;
- private:
-
- /** The current timer set, a map of timergroups
- */
- timerlist Timers;
+ std::vector<Timer *> Timers;
public:
/** Constructor
*/
- TimerManager(InspIRCd* Instance);
- /** Tick all pending InspTimers
+ TimerManager();
+ ~TimerManager();
+
+ /** 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
- * @param secs_from_now You may set this to the number of seconds
- * from the current time when the timer will tick, or you may just
- * leave this unset and the values set by the InspTimers constructor
- * will be used. This is used internally for re-triggering repeating
- * timers.
- */
- void AddTimer(InspTimer* T, long secs_from_now = 0);
- /** 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
+
+ /** Add an Timer
+ * @param T an Timer derived class to add
*/
- void TickMissedTimers(time_t TIME);
+ void AddTimer(Timer *T);
+
+ /** Delete an Timer
+ * @param T an Timer derived class to delete
+ */
+ void DelTimer(Timer* T);
+
+ /** Compares two timers
+ */
+ static bool TimerComparison( Timer *one, Timer*two);
};
#endif
+
projects / user / henk / code / inspircd.git / blobdiff