Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
No Matches
k_timeout_t Struct Reference

Kernel timeout type. More...

#include <sys_clock.h>

Data Fields

k_ticks_t ticks

Detailed Description

Kernel timeout type.

Timeout arguments presented to kernel APIs are stored in this opaque type, which is capable of representing times in various formats and units. It should be constructed from application data using one of the macros defined for this purpose (e.g. K_MSEC(), K_TIMEOUT_ABS_TICKS(), etc...), or be one of the two constants K_NO_WAIT or K_FOREVER. Applications should not inspect the internal data once constructed. Timeout values may be compared for equality with the K_TIMEOUT_EQ() macro.

Field Documentation

◆ ticks

k_ticks_t k_timeout_t::ticks

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