Rtos API example

Embed: (wiki syntax)

« Back to documentation index

stats functions

stats functions
[Platform]

Data Structures

struct  mbed_stats_heap_t
 struct mbed_stats_heap_t definition More...
struct  mbed_stats_stack_t
 struct mbed_stats_stack_t definition More...

Functions

void mbed_stats_heap_get (mbed_stats_heap_t *stats)
 Fill the passed in heap stat structure with heap stats.
void mbed_stats_stack_get (mbed_stats_stack_t *stats)
 Fill the passed in structure with stack stats accumulated for all threads.
size_t mbed_stats_stack_get_each (mbed_stats_stack_t *stats, size_t count)
 Fill the passed array of stat structures with the stack stats for each available thread.

Function Documentation

void mbed_stats_heap_get ( mbed_stats_heap_t stats )

Fill the passed in heap stat structure with heap stats.

Parameters:
statsA pointer to the mbed_stats_heap_t structure to fill

Definition at line 57 of file mbed_alloc_wrappers.cpp.

void mbed_stats_stack_get ( mbed_stats_stack_t stats )

Fill the passed in structure with stack stats accumulated for all threads.

The thread_id will be 0 and stack_cnt will represent number of threads.

Parameters:
statsA pointer to the mbed_stats_stack_t structure to fill

Definition at line 12 of file mbed_stats.c.

size_t mbed_stats_stack_get_each ( mbed_stats_stack_t stats,
size_t  count 
)

Fill the passed array of stat structures with the stack stats for each available thread.

Parameters:
statsA pointer to an array of mbed_stats_stack_t structures to fill
countThe number of mbed_stats_stack_t structures in the provided array
Returns:
The number of mbed_stats_stack_t structures that have been filled, this is equal to the number of stacks on the system.

Definition at line 39 of file mbed_stats.c.