Cpl::System::Timer Class Reference

This mostly concrete interface defines the operations that can be performed on a software timer. More...

Detailed Description

This mostly concrete interface defines the operations that can be performed on a software timer.

Software timers execute 'in-thread' in that all operations (start, timer expired callbacks, etc.) are performed in a single thread.

Because the timer context (i.e. the timer owner), timer methods and callbacks all occur in the same thread, the timer context will never receive a timer expired callback AFTER the timer's stop() method has been called.

NOTES: o The timer context must implement the following method: virtual void expired( void ) noexcept;

o Because the timing source of an individual thread may NOT be a clean divider of the timer duration, the timer duration is taken as the minimum. For example: if the timing source has a resolution of 20msec per count, and the timer duration on the start() timer call is 5 msec, then the timer will expire after the next full count, i.e. after 20msec, not 5msec. IT IS THE APPLICATION'S RESPONSIBILITY TO MANAGE THE RESOLUTION OF THE TIMING SOURCES.

#include <Timer.h>

Inheritance diagram for Cpl::System::Timer:

Collaboration diagram for Cpl::System::Timer:

Public Member Functions
	Timer (TimerManager &timingSource)
	Constructor
	Timer ()
	Constructor. Alternate constructor - that defers the assignment of the timing source
virtual void	start (unsigned long timerDurationInMilliseconds) noexcept
	Starts the timer with an initial count down count duration of 'timerDurationInMilliseconds'.
virtual void	stop () noexcept
	Stops the timer.
unsigned long	count () const noexcept
	Returns the current count (in milliseconds)
virtual void	setTimingSource (TimerManager &timingSource) noexcept
	Sets the timing source.
Public Member Functions inherited from Cpl::System::CounterCallback_
virtual void	expired (void) noexcept=0
	Notification of the count reaching zero.
virtual	~CounterCallback_ ()
	Virtual Destructor.
Public Member Functions inherited from Cpl::Container::Item
bool	insert_ (void *newContainerPtr)
	Helper method to trap when inserting an item in multiple containers.
bool	isInContainer_ (const void *containerPtr) const noexcept
	Returns 'true' if the instance is in the specified container.

Protected Member Functions
void	decrement (unsigned long milliseconds=1) noexcept
	See Cpl::System::CounterCallback_.
void	increment (unsigned long milliseconds) noexcept
	See Cpl::System::CounterCallback_.
Protected Member Functions inherited from Cpl::Container::ExtendedItem
	ExtendedItem ()
	Constructor.
	ExtendedItem (const char *ignoreThisParameter_usedToCreateAUniqueConstructor)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.
Protected Member Functions inherited from Cpl::Container::Item
	Item ()
	Constructor.
	Item (const char *)
	Constructor used ONLY with the child class MapItem: -->special constructor to allow a Map to be statically allocated.

Protected Attributes
TimerManager *	m_timingSource
	The timer's tick source.
unsigned long	m_count
	Current count.

Additional Inherited Members
Static Public Member Functions inherited from Cpl::Container::Item
static void	remove_ (Item *itemPtr) noexcept
	Helper method to do the proper 'clean-up' for the multiple-containers-error-trap when removing an item from a container.
Public Attributes inherited from Cpl::Container::ExtendedItem
void *	m_prevPtr_
	The previous link field.
Public Attributes inherited from Cpl::Container::Item
void *	m_nextPtr_
	The link field.
void *	m_inListPtr_
	Debug field.

Constructor & Destructor Documentation

Timer() [1/2]

Cpl::System::Timer::Timer

(

TimerManager &

timingSource

)

Constructor

Timer() [2/2]

Cpl::System::Timer::Timer

(

)

Constructor. Alternate constructor - that defers the assignment of the timing source

Member Function Documentation

count()

unsigned long Cpl::System::Timer::count ( ) const

virtualnoexcept

Returns the current count (in milliseconds)

Implements Cpl::System::CounterCallback_.

decrement()

void Cpl::System::Timer::decrement ( unsigned long  milliseconds = 1 )

protectedvirtualnoexcept

See Cpl::System::CounterCallback_.

Implements Cpl::System::CounterCallback_.

increment()

void Cpl::System::Timer::increment ( unsigned long  milliseconds )

protectedvirtualnoexcept

See Cpl::System::CounterCallback_.

Implements Cpl::System::CounterCallback_.

setTimingSource()

virtual void Cpl::System::Timer::setTimingSource ( TimerManager &  timingSource )

virtualnoexcept

Sets the timing source.

This method CAN ONLY BE CALLED when the timer is has never been started or it has been stopped

start()

virtual void Cpl::System::Timer::start ( unsigned long  timerDurationInMilliseconds )

virtualnoexcept

Starts the timer with an initial count down count duration of 'timerDurationInMilliseconds'.

If the timer is currently running, the timer is first stopped, and then restarted.

stop()

virtual void Cpl::System::Timer::stop ( )

virtualnoexcept

Stops the timer.

It is okay to call stop() even after the timer has previously expired or explicitly stopped.

Reimplemented in Cpl::Dm::Persistent::Record.

Member Data Documentation

m_count

unsigned long Cpl::System::Timer::m_count

protected

Current count.

m_timingSource

TimerManager* Cpl::System::Timer::m_timingSource

protected

The timer's tick source.

---

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

• Cpl/System/Timer.h