X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=include%2Ftimer.h;h=16784fecdeae19756daf0da04f87f0e39d4e918f;hb=635cb9d65f6d7f6758ae8ed874da00c8d94b6e39;hp=6a4c9063b7316c92cdf046930c898b884b24a5b6;hpb=09dd16b981c38cbde7573398cb50ae1cf0531ade;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/include/timer.h b/include/timer.h index 6a4c9063b..16784fecd 100644 --- a/include/timer.h +++ b/include/timer.h @@ -1,61 +1,146 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev. - * E-mail: - * - * + * 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 Dennis Friis + * Copyright (C) 2006-2007, 2010 Craig Edwards * - * Written by Craig Edwards, Craig McLure, and others. - * 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 + +#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 +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 bool Tick(time_t TIME) = 0; + + /** Returns true if this timer is set to repeat */ - virtual void Tick(time_t TIME) = 0; + 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; + } }; -void TickTimers(time_t TIME); -void AddTimer(InspTimer* T); -void TickMissedTimers(time_t TIME); +/** 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); -#endif + /** Remove a Timer + * @param T an Timer derived class to remove + */ + void DelTimer(Timer* T); +};