stk_helper.h File Reference

Contains helper implementations which simplify user-side code. More...

#include "stk_common.h"
#include "stk_arch.h"

Include dependency graph for stk_helper.h:

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

Go to the source code of this file.

Classes
class	stk::Task< _StackSize, _AccessMode >
	Partial implementation of the user task. More...
class	stk::TaskW< _Weight, _StackSize, _AccessMode >
	Partial implementation of the user task with a compile-time scheduling weight. Use when the kernel is configured with SwitchStrategySmoothWeightedRoundRobin. More...
class	stk::StackMemoryWrapper< _StackSize >
	Adapts an externally-owned stack memory array to the IStackMemory interface. More...

Namespaces
namespace	stk
	Namespace of STK package.

Functions
TId	stk::GetTid ()
	Get task/thread Id of the calling task.
int64_t	stk::GetMsFromTicks (int64_t ticks, int32_t resolution)
	Convert ticks to milliseconds.
Ticks	stk::GetTicksFromMs (int64_t ms, int32_t resolution)
	Convert milliseconds to ticks.
Ticks	stk::GetTicks ()
	Get number of ticks elapsed since kernel start.
int32_t	stk::GetTickResolution ()
	Get number of microseconds in one tick.
Ticks	stk::GetTicksFromMs (int64_t ms)
	Convert milliseconds to ticks using the current kernel tick resolution.
static int64_t	stk::GetTimeNowMs ()
	Get current time in milliseconds since kernel start.
void	stk::Sleep (uint32_t ticks)
	Put calling process into a sleep state.
static void	stk::SleepMs (uint32_t ms)
	Put calling process into a sleep state.
void	stk::SleepUntil (Ticks timestamp)
	Put calling process into a sleep state until the specified timestamp.
void	stk::Yield ()
	Notify scheduler to switch to the next runnable task.
void	stk::Delay (uint32_t ticks)
	Delay calling process by busy-waiting until the deadline expires.
static void	stk::DelayMs (uint32_t ms)
	Delay calling process by busy-waiting until the deadline expires.

Detailed Description

Contains helper implementations which simplify user-side code.

Definition in file stk_helper.h.