Cpl::System::TimerManager Class Reference

This mostly concrete class implements manages a list of Software Timers. More...

Detailed Description

This mostly concrete class implements manages a list of Software Timers.

When an individual Timer object's count reaches zero, its callback method is invoked and it is remove from the Active List. The Active List is designed to be very efficient with respect to decrement counts when there are many Timers in the list, i.e. the amount of time to decrement the individual Timers is NOT a function of the number of active Timers.

The Timer Manager requires that the Timer Manager instances, all Timer instances, add the Timer's Context (i.e. the code that executes the timer expired callbacks) all execute in the SAME thread.

#include <TimerManager.h>

Inheritance diagram for Cpl::System::TimerManager:

Collaboration diagram for Cpl::System::TimerManager:

Public Member Functions
	TimerManager ()
	Constructor.
void	startManager (void) noexcept
	This method starts the Timer Manager.
void	processTimers (void) noexcept
	This method processes the current active timer lists.
bool	areActiveTimers (void) noexcept
	Returns true if there are NO active timers.
void	attach (CounterCallback_ &clientToCallback) noexcept
	See Cpl::System::CounterCallback_.
bool	detach (CounterCallback_ &clientToCallback) noexcept
	See Cpl::System::CounterCallback_.
unsigned long	msecToCounts (unsigned long milliseconds) noexcept
	See Cpl::System::CounterCallback_.
Public Member Functions inherited from Cpl::System::CounterSource_
virtual	~CounterSource_ ()
	Virtual Destructor.

Protected Member Functions
void	addToActiveList (CounterCallback_ &clientToCallback) noexcept
	Helper method.
virtual void	tick (unsigned long milliseconds=1) noexcept
	This method is intended to be call by a the timing source and each call to this method represents that one tick has expired, i.e.
virtual void	tickComplete (void) noexcept
	This method is used by the Tick source to information the Timer Manager that there are no more ticks for the timing source's current tick cycle.

Protected Attributes
Cpl::Container::DList< CounterCallback_ >	m_counters
	List of active counters.
Cpl::Container::DList< CounterCallback_ >	m_pendingAttach
	List of Pending-to-attach counters (this happens when timers attach from the timer-expired-callbacks)
unsigned long	m_timeMark
	Elapsed time of the previous processing cycle.
unsigned long	m_timeNow
	Elapsed time of the current processing cycle.
bool	m_inTickCall
	Flag to tracks when I am actively processing/consuming ticks.

Constructor & Destructor Documentation

TimerManager()

Cpl::System::TimerManager::TimerManager

(

)

Constructor.

Member Function Documentation

addToActiveList()

void Cpl::System::TimerManager::addToActiveList ( CounterCallback_ &  clientToCallback )

protectednoexcept

Helper method.

areActiveTimers()

bool Cpl::System::TimerManager::areActiveTimers ( void  )

noexcept

Returns true if there are NO active timers.

attach()

void Cpl::System::TimerManager::attach ( CounterCallback_ &  clientToCallback )

virtualnoexcept

See Cpl::System::CounterCallback_.

Implements Cpl::System::CounterSource_.

detach()

bool Cpl::System::TimerManager::detach ( CounterCallback_ &  clientToCallback )

virtualnoexcept

See Cpl::System::CounterCallback_.

Implements Cpl::System::CounterSource_.

msecToCounts()

unsigned long Cpl::System::TimerManager::msecToCounts ( unsigned long  milliseconds )

virtualnoexcept

See Cpl::System::CounterCallback_.

Implements Cpl::System::CounterSource_.

processTimers()

void Cpl::System::TimerManager::processTimers ( void  )

noexcept

This method processes the current active timer lists.

For each timer that has expired, the timer's context callback method is called.

startManager()

void Cpl::System::TimerManager::startManager ( void  )

noexcept

This method starts the Timer Manager.

This method should be called only once just before the Main/Event loop processing begins.

This method must be called from the same thread that the Timer Manager executes in.

tick()

virtual void Cpl::System::TimerManager::tick ( unsigned long  milliseconds = 1 )

protectedvirtualnoexcept

This method is intended to be call by a the timing source and each call to this method represents that one tick has expired, i.e.

decrement the active Counter objects' by one.

tickComplete()

virtual void Cpl::System::TimerManager::tickComplete ( void  )

protectedvirtualnoexcept

This method is used by the Tick source to information the Timer Manager that there are no more ticks for the timing source's current tick cycle.

Member Data Documentation

m_counters

Cpl::Container::DList<CounterCallback_> Cpl::System::TimerManager::m_counters

protected

List of active counters.

m_inTickCall

bool Cpl::System::TimerManager::m_inTickCall

protected

Flag to tracks when I am actively processing/consuming ticks.

m_pendingAttach

Cpl::Container::DList<CounterCallback_> Cpl::System::TimerManager::m_pendingAttach

protected

List of Pending-to-attach counters (this happens when timers attach from the timer-expired-callbacks)

m_timeMark

unsigned long Cpl::System::TimerManager::m_timeMark

protected

Elapsed time of the previous processing cycle.

m_timeNow

unsigned long Cpl::System::TimerManager::m_timeNow

protected

Elapsed time of the current processing cycle.

---

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

• Cpl/System/TimerManager.h