stk_time_timer.h File Reference

Implementation of stk::time::TimerHost, a software timer multiplexer that manages multiple stk::time::TimerHost::Timer instances. More...

#include "sync/stk_sync_event.h"
#include "sync/stk_sync_pipe.h"

Include dependency graph for stk_time_timer.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	stk::time::TimerHost
	Software timer multiplexer that manages multiple Timer instances on top of a small fixed set of kernel tasks. More...
class	stk::time::TimerHost::Timer
	Abstract base class for a timer managed by TimerHost. More...
class	stk::time::TimerHost::TimerWorkerTask
	Internal kernel task used by TimerHost for both the tick task and handler tasks. More...
struct	stk::time::TimerHost::TimerCommand
	POD command record passed from the public API methods to the tick task via the command queue. More...

Namespaces
namespace	stk
	Namespace of STK package.
namespace	stk::time
	Time-related primitives.

Macros
#define	STK_TIMER_THREADS_COUNT   1U
	Number of threads handling timers in TimerHost (default: 1).
#define	STK_TIMER_HANDLER_STACK_SIZE   256U
	Stack size of the timer handler, increase if your timers consume more (default: 256).
#define	STK_TIMER_COUNT_MAX   32U
	Max number of timers handled by TimerHost (default: 32).

Detailed Description

Implementation of stk::time::TimerHost, a software timer multiplexer that manages multiple stk::time::TimerHost::Timer instances.

Definition in file stk_time_timer.h.

Macro Definition Documentation

STK_TIMER_COUNT_MAX

#define STK_TIMER_COUNT_MAX   32U

Max number of timers handled by TimerHost (default: 32).

Definition at line 42 of file stk_time_timer.h.

STK_TIMER_HANDLER_STACK_SIZE

#define STK_TIMER_HANDLER_STACK_SIZE   256U

Stack size of the timer handler, increase if your timers consume more (default: 256).

Definition at line 35 of file stk_time_timer.h.

STK_TIMER_THREADS_COUNT

#define STK_TIMER_THREADS_COUNT   1U

Number of threads handling timers in TimerHost (default: 1).

Definition at line 28 of file stk_time_timer.h.

Referenced by stk::time::TimerHost::Initialize(), and stk::time::TimerHost::ProcessCommands().