summaryrefslogtreecommitdiff
path: root/include/timer.h
blob: 4d1eee470f5fc944a5932d50668b008eff583768 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
/*       +------------------------------------+
 *       | 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;
};

class TimerManager : public Extensible
{
 protected:

	typedef std::vector<InspTimer*> timergroup;
	typedef std::map<time_t, timergroup*> timerlist;

 private:

	timerlist Timers;

 public:
	void TickTimers(time_t TIME);
	void AddTimer(InspTimer* T);
	void TickMissedTimers(time_t TIME);
};

#endif