mirror of
https://github.com/inspircd/inspircd.git
synced 2025-03-10 11:09:04 -04:00
b6a20325ca
git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@4899 e03df62e-2008-0410-955e-edbf42e46eb7
94 lines
2.4 KiB
C++
94 lines
2.4 KiB
C++
/* +------------------------------------+
|
|
* | Inspire Internet Relay Chat Daemon |
|
|
* +------------------------------------+
|
|
*
|
|
* InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
|
|
* E-mail:
|
|
* <brain@chatspike.net>
|
|
* <Craig@chatspike.net>
|
|
*
|
|
* Written by Craig Edwards, Craig McLure, and others.
|
|
* This program is free but copyrighted software; see
|
|
* the file COPYING for details.
|
|
*
|
|
* ---------------------------------------------------
|
|
*/
|
|
|
|
#ifndef INSPIRCD_TIMER_H
|
|
#define INSPIRCD_TIMER_H
|
|
|
|
/** 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 InspTimer : public Extensible
|
|
{
|
|
private:
|
|
/** The triggering time
|
|
*/
|
|
time_t trigger;
|
|
public:
|
|
/** Default constructor, initializes the triggering time
|
|
*/
|
|
InspTimer(long secs_from_now,time_t now)
|
|
{
|
|
trigger = now + secs_from_now;
|
|
}
|
|
/** Default destructor, does nothing.
|
|
*/
|
|
virtual ~InspTimer() { }
|
|
/** Retrieve the current triggering time
|
|
*/
|
|
virtual time_t GetTimer()
|
|
{
|
|
return trigger;
|
|
}
|
|
/** Called when the timer ticks.
|
|
*/
|
|
virtual void Tick(time_t TIME) = 0;
|
|
};
|
|
|
|
|
|
/** 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 TimerManager : public Extensible
|
|
{
|
|
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:
|
|
|
|
/** The current timer set, a map of timergroups
|
|
*/
|
|
timerlist Timers;
|
|
|
|
public:
|
|
/** 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
|
|
*/
|
|
void AddTimer(InspTimer* T);
|
|
/** Tick any timers that have been missed due to lag
|
|
* @param TIME the current system time
|
|
*/
|
|
void TickMissedTimers(time_t TIME);
|
|
};
|
|
|
|
#endif
|