Tonido::Misc::FixedTimerList Class Reference

A timer list that invokes user callbacks at fixed time resolution. More...

List of all members.

Public Types
typedef Poco::BasicEvent < TimerEventInfo >	TimerEvent
Public Member Functions
	FixedTimerList ()
	Ctor.
	~FixedTimerList ()
	Dtor.
void	setTimerResolution (int resolution)
	Sets the timer resolution for all timers held by this fixed timer list.
void	addTimerCallback (TimerEventInfo::SharedPtr &pTEI)
	Adds the given delegate to be invoked when the timer expires.
void	removeTimerCallback (const std::string &a_serviceName, const std::string &a_tag)
	This removes the given delegate from the timer expiry list.
int	getTimerResolution ()
	Gets the timer resolution of this fixed timer list.
void	tickClock ()
	Runs all the delegates.
TimerEvent &	getTimerEvent ()
	Gets the Delegate for the timer callback.

---

Detailed Description

A timer list that invokes user callbacks at fixed time resolution.

Description: Container that contains a timer list which will invoke the user callbacks at the appropriate time. Note that all timers have to have the same time resolution.

---

Constructor & Destructor Documentation

Tonido::Misc::FixedTimerList::FixedTimerList

(

)

Ctor.

details if needed ...

Tonido::Misc::FixedTimerList::~FixedTimerList

(

)

Dtor.

details if needed ...

---

Member Function Documentation

void Tonido::Misc::FixedTimerList::addTimerCallback

(

TimerEventInfo::SharedPtr &

pTEI

)

Adds the given delegate to be invoked when the timer expires.

Parameters:

[in]

pTEI

is the TimerEventInfo which contains the delagate and time

Returns:

none

TimerEvent& Tonido::Misc::FixedTimerList::getTimerEvent

(

)

Gets the Delegate for the timer callback.

Parameters:

[in]

none

Returns:

TimerEvent

int Tonido::Misc::FixedTimerList::getTimerResolution

(

)

Gets the timer resolution of this fixed timer list.

Parameters:

[in]

none

Returns:

resolution in milliseconds

void Tonido::Misc::FixedTimerList::removeTimerCallback	(	const std::string &	a_serviceName,
		const std::string &	a_tag
	)

This removes the given delegate from the timer expiry list.

Parameters:

[in]	a_serviceName	is the name of the service
[in]	a_tag	is the name of the tag for this timer

Returns:

none

void Tonido::Misc::FixedTimerList::setTimerResolution

(

int

resolution

)

Sets the timer resolution for all timers held by this fixed timer list.

This is the timer resolution for all timers held by this fixed timer list. The timer resolution is in milliseconds.

Parameters:

[in]

resolution

is timer resolution in milliseconds

Returns:

none

void Tonido::Misc::FixedTimerList::tickClock

(

)

Runs all the delegates.

Parameters:

[in]

none

Returns:

none