BaTimer Struct Reference

The timer class makes it possible to create events that are activated at regular intervals or to create events that are activated only one time. More...

#include <BaTimer.h>

Inheritance diagram for BaTimer:

Collaboration diagram for BaTimer:

List of all members.

Public Member Functions
	BaTimer (ThreadMutex *mutex, int stackSize, BaTime ticklen=10, ThreadPriority priority=ThreadPrioNormal, AllocatorIntf *alloc=0)
	Create a BaTimer object and one thread.
	~BaTimer ()
	Terminate the timer.
U32	set (BaTimer_CB cb, void *data, U32 milliSec)
	Create a timer event.
int	reset (U32 tkey, U32 milliSec)
	Resets the timer.
int	cancel (U32 tkey)
	Cancels the timer.

---

Detailed Description

The timer class makes it possible to create events that are activated at regular intervals or to create events that are activated only one time.

---

Constructor & Destructor Documentation

BaTimer::BaTimer	(	ThreadMutex *	mutex,
		int	stackSize,
		BaTime	ticklen = 10,
		ThreadPriority	priority = ThreadPrioNormal,
		AllocatorIntf *	alloc = 0
	)

Create a BaTimer object and one thread.

Parameters:

mutex
stackSize
ticklen
priority
alloc

---

Member Function Documentation

int BaTimer::cancel

(

U32

tkey

)

Cancels the timer.

Parameters:

tkey	the timer key. web-server callback i.e. called from another thread.

int BaTimer::reset	(	U32	tkey,
		U32	milliSec
	)

Resets the timer.

Parameters:

tkey	the timer key.
milliSec	the new timeout. web-server callback i.e. called from another thread.

U32 BaTimer::set	(	BaTimer_CB	cb,
		void *	data,
		U32	milliSec
	)

Create a timer event.

Parameters:

cb	the timer event function.
data	transparent data passed to the event callback.
milliSec	the timer callback function is activated in "millisecs" time, unless method "reset" or "cancelled" is called before the timer triggers. web-server callback i.e. called from another thread.

Returns:

the timer key.