Timer Class Reference

#include <timer.h>

Inheritance diagram for Timer:

Public Member Functions
	Timer (long secs_from_now, time_t now, bool repeating=false)
virtual	~Timer ()
virtual time_t	GetTimer ()
virtual void	SetTimer (time_t t)
virtual void	Tick (time_t TIME)=0
bool	GetRepeat ()
long	GetSecs ()
void	CancelRepeat ()

Detailed Description

Timer class for one-second resolution timers 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 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.

Constructor & Destructor Documentation

Timer()

Timer::Timer ( long  secs_from_now, time_t  now, bool  repeating = false  )

inline

Default constructor, initializes the triggering time

Parameters

secs_from_now	The number of seconds from now to trigger the timer
now	The time now
repeating	Repeat this timer every secs_from_now seconds if set to true

~Timer()

virtual Timer::~Timer ( )

inlinevirtual

Default destructor, does nothing.

Member Function Documentation

CancelRepeat()

void Timer::CancelRepeat ( )

inline

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. 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 Timer::Tick() method is dangerous and may cause a segmentation fault. Calling CancelRepeat() is safe in this case.

GetRepeat()

bool Timer::GetRepeat ( )

inline

Returns true if this timer is set to repeat

GetSecs()

long Timer::GetSecs ( )

inline

Returns the interval (number of seconds between ticks) of this timer object.

GetTimer()

virtual time_t Timer::GetTimer ( )

inlinevirtual

Retrieve the current triggering time

SetTimer()

virtual void Timer::SetTimer ( time_t  t )

inlinevirtual

Sets the trigger timeout to a new value

Tick()

virtual void Timer::Tick ( time_t  TIME )

pure virtual

Called when the timer ticks. You should override this method with some useful code to handle the tick event.

Implemented in RequestTimeout, CacheTimer, and SocketTimeout.

---

The documentation for this class was generated from the following file:

• include/timer.h