Mistake on this page?
Report an issue in GitHub or email us
Functions
rtos::Kernel Namespace Reference

Functions in the Kernel namespace control RTOS kernel information. More...

Functions

uint64_t get_ms_count ()
 Read the current RTOS kernel millisecond tick count. More...
 
void attach_idle_hook (void(*fptr)(void))
 Attach a function to be called by the RTOS idle task. More...
 
void attach_thread_terminate_hook (void(*fptr)(osThreadId_t id))
 Attach a function to be called when a thread terminates. More...
 

Detailed Description

Functions in the Kernel namespace control RTOS kernel information.

Function Documentation

void rtos::Kernel::attach_idle_hook ( void(*)(void)  fptr)

Attach a function to be called by the RTOS idle task.

Parameters
fptrpointer to the function to be called
Note
You may call this function from ISR context.
void rtos::Kernel::attach_thread_terminate_hook ( void(*)(osThreadId_t id)  fptr)

Attach a function to be called when a thread terminates.

Parameters
fptrpointer to the function to be called
Note
You may call this function from ISR context.
uint64_t rtos::Kernel::get_ms_count ( )

Read the current RTOS kernel millisecond tick count.

The tick count corresponds to the tick count the RTOS uses for timing purposes. It increments monotonically from 0 at boot, so it effectively never wraps. If the underlying RTOS only provides a 32-bit tick count, this method expands it to 64 bits.

Returns
RTOS kernel current tick count
Note
Mbed OS always uses millisecond RTOS ticks, and this could only wrap after half a billion years.
You cannot call this function from ISR context.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.