X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Ftimer.h;h=193e5909b759544573caa898b2832ba68d1a767b;hb=27f8e788c2a515f63f1f0e5e2b4b0d5e78c3dab4;hp=ad4f5ef8760b0cfadb7dd7b66734a78f2ec45fc6;hpb=bab14f0dd2345c9d7dcbc47c918563709e1ac094;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/timer.h b/include/timer.h index ad4f5ef87..193e5909b 100644 --- a/include/timer.h +++ b/include/timer.h @@ -1 +1,146 @@ -/* +------------------------------------+ * | Inspire Internet Relay Chat Daemon | * +------------------------------------+ * * InspIRCd: (C) 2002-2007 InspIRCd Development Team * See: http://www.inspircd.org/wiki/index.php/Credits * * This program is free but copyrighted software; see * the file COPYING for details. * * --------------------------------------------------- */ #ifndef INSPIRCD_TIMER_H #define INSPIRCD_TIMER_H class InspIRCd; /** 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 CoreExport InspTimer : public Extensible { private: /** The triggering time */ time_t trigger; /** Number of seconds between triggers */ long 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 */ InspTimer(long secs_from_now,time_t now, bool repeating = false) { trigger = now + secs_from_now; secs = secs_from_now; repeat = repeating; } /** Default destructor, does nothing. */ virtual ~InspTimer() { } /** Retrieve the current triggering time */ virtual time_t GetTimer() { return trigger; } /** Called when the timer ticks. * You should override this method with some useful code to * handle the tick event. */ virtual void Tick(time_t TIME) = 0; /** Returns true if this timer is set to repeat */ bool GetRepeat() { return repeat; } /** Returns the interval (number of seconds between ticks) * of this timer object. */ long GetSecs() { 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. * 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 * cause a segmentation fault. Calling CancelRepeat() * is safe in this case. */ void CancelRepeat() { repeat = false; } }; /** 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 CoreExport TimerManager : public Extensible { protected: /** A group of timers all set to trigger at the same time */ typedef std::vector timergroup; /** A map of timergroups, each group has a specific trigger time */ typedef std::map timerlist; /** Set when ticking timers, to prevent deletion while iterating */ bool CantDeleteHere; /** Creating server instance */ InspIRCd* ServerInstance; private: /** The current timer set, a map of timergroups */ timerlist Timers; public: /** Constructor */ TimerManager(InspIRCd* Instance); /** 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 * @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 */ void TickMissedTimers(time_t TIME); }; #endif \ No newline at end of file +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2013-2014 Attila Molnar + * Copyright (C) 2013, 2017 Sadie Powell + * Copyright (C) 2012 Robby + * Copyright (C) 2009 Uli Schlachter + * Copyright (C) 2009 Daniel De Graaf + * Copyright (C) 2007-2008 Robin Burchell + * Copyright (C) 2007, 2010 Craig Edwards + * Copyright (C) 2007 Dennis Friis + * + * 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 . + */ + + +#pragma once + +class Module; + +/** Timer class for one-second resolution timers + * 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 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 have to override) will be called + * at the given time. + */ +class CoreExport Timer +{ + /** 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 + */ + Timer(unsigned int secs_from_now, bool repeating = false); + + /** Default destructor, removes the timer from the timer manager + */ + virtual ~Timer(); + + /** Retrieve the current triggering time + */ + 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 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 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 +{ + typedef std::multimap TimerMap; + + /** A list of all pending timers + */ + TimerMap Timers; + + public: + /** Tick all pending Timers + * @param TIME the current system time + */ + void TickTimers(time_t TIME); + + /** Add an Timer + * @param T an Timer derived class to add + */ + void AddTimer(Timer *T); + + /** Remove a Timer + * @param T an Timer derived class to remove + */ + void DelTimer(Timer* T); +};