X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Ftimer.h;h=9bb7128b85ac7f6283ec51a0e6986fc7464a6a1d;hb=4c751dbbe8945e5efc230a59b0ed51c2ba10cf92;hp=ef8b82e31f64d728d662c35769af20842e162a9a;hpb=f2acdbc3820f0f4f5ef76a0a64e73d2a320df91f;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/timer.h b/include/timer.h index ef8b82e31..9bb7128b8 100644 --- a/include/timer.h +++ b/include/timer.h @@ -1,32 +1,38 @@ -/* +------------------------------------+ - * | 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 + * Copyright (C) 2007 Dennis Friis + * Copyright (C) 2006-2007 Craig Edwards * - * 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 . */ + #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 CoreExport InspTimer : public Extensible +class CoreExport Timer { private: /** The triggering time @@ -44,7 +50,7 @@ class CoreExport InspTimer : public Extensible * @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; @@ -53,7 +59,7 @@ class CoreExport InspTimer : public Extensible /** Default destructor, does nothing. */ - virtual ~InspTimer() { } + virtual ~Timer() { } /** Retrieve the current triggering time */ @@ -62,6 +68,13 @@ class CoreExport InspTimer : public Extensible 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. @@ -89,7 +102,7 @@ class CoreExport InspTimer : public Extensible * 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. */ @@ -100,56 +113,41 @@ class CoreExport InspTimer : public Extensible }; -/** 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 CoreExport TimerManager : public Extensible +class CoreExport TimerManager { 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 + /** A list of all pending timers */ - InspIRCd* ServerInstance; - private: - - /** The current timer set, a map of timergroups - */ - timerlist Timers; + std::vector 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 AddTimer(Timer *T); + + /** Delete an Timer + * @param T an Timer derived class to delete + */ + void DelTimer(Timer* T); + + /** Compares two timers */ - void TickMissedTimers(time_t TIME); + static bool TimerComparison( Timer *one, Timer*two); }; #endif