vsk_Timer

Data Structures
struct	vsk_Timer_Class
	Timer class. More...
struct	vsk_Timer
	Software timer. More...

Typedefs
typedef struct vsk_Timer_Class	vsk_Timer_Class_t
	Timer class.
typedef struct vsk_Timer	vsk_Timer_t
	Software timer.
typedef void(*	vsk_Timer_Callback_t) (void *const obj)
	Timer callback.

Functions
vsk_Timer_Class_t *	vsk_Timer_Class_init (vsk_Timer_Class_t *const cls)
	Initializes the Timer class.
void	vsk_Timer_Class_onTick (vsk_Timer_Class_t *const cls)
	Propagates the system tick to all timers.
vsk_Timer_t *	vsk_Timer_init (vsk_Timer_t *const self, uint32_t const delayMillis, uint32_t const periodMillis, vsk_Timer_Callback_t const callback, void *const obj)
	Initializes a timer.
void	vsk_Timer_start (vsk_Timer_t *const self)
	Starts the timer.
void	vsk_Timer_stop (vsk_Timer_t *const self)
	Stops the timer.
bool	vsk_Timer_isRunning (vsk_Timer_t *const self)
	Checks if the timer is running.

Variables
vsk_Timer_Class_t	vsk_Timer_Class
	Timer class instance.

Detailed Description

Function Documentation

vsk_Timer_Class_init()

vsk_Timer_Class_t * vsk_Timer_Class_init

(

vsk_Timer_Class_t *const

cls

)

Initializes the Timer class.

Parameters

cls	Timer class reference

Returns

Initialized Timer class reference

vsk_Timer_Class_onTick()

void vsk_Timer_Class_onTick

(

vsk_Timer_Class_t *const

cls

)

Propagates the system tick to all timers.

Parameters

cls	Timer class reference

vsk_Timer_init()

vsk_Timer_t * vsk_Timer_init	(	vsk_Timer_t *const	self,
		uint32_t const	delayMillis,
		uint32_t const	periodMillis,
		vsk_Timer_Callback_t const	callback,
		void *const	obj )

Initializes a timer.

Parameters

self	Timer reference
delayMillis	Initial delay of the timer in milliseconds
periodMillis	Period of the timer after the initial delay in milliseconds
callback	Callback function (called on timer expiration)
obj	Object reference to pass to the callback (can be NULL)

Returns

Initialized Timer reference

vsk_Timer_isRunning()

bool vsk_Timer_isRunning

(

vsk_Timer_t *const

self

)

Checks if the timer is running.

Parameters

self	Timer reference

Returns

true if the timer is running

false if the timer is not running

vsk_Timer_start()

void vsk_Timer_start

(

vsk_Timer_t *const

self

)

Starts the timer.

Parameters

self	Timer reference

vsk_Timer_stop()

void vsk_Timer_stop

(

vsk_Timer_t *const

self

)

Stops the timer.

Parameters

self	Timer reference