From 572a7b503b434367e57ba1624f415e1c472e18a2 Mon Sep 17 00:00:00 2001 From: brain Date: Sun, 12 Mar 2006 18:03:02 +0000 Subject: Commented a lot of stuff that hasnt been commented since 1.0.2 git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@3695 e03df62e-2008-0410-955e-edbf42e46eb7 --- include/timer.h | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) (limited to 'include/timer.h') diff --git a/include/timer.h b/include/timer.h index b75f3776f..3c4fb0897 100644 --- a/include/timer.h +++ b/include/timer.h @@ -14,23 +14,41 @@ * --------------------------------------------------- */ +/** 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 { 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; } - virtual void Tick(time_t TIME) - { - } + /** Called when the timer ticks. + */ + virtual void Tick(time_t TIME) = 0; }; void TickTimers(time_t TIME); -- cgit v1.2.3