Thread attributes. More...

#include <cmsis-plus/rtos/os-c-api.h>

Public Attributes
void *	clock
	Address of the clock to use for timeouts. More...

os_thread_prio_t	th_priority
	Thread initial priority. More...

void *	th_stack_address
	Address of the user defined storage for the thread stack. More...

size_t	th_stack_size_bytes
	Size of the user defined storage for the thread stack, in bytes. More...

Detailed Description

Thread attributes.

Initialise this structure with os_thread_attr_init(), and then set any of the individual members directly.

See also: os::rtos::thread::attributes

Definition at line 489 of file os-c-decls.h.

Member Data Documentation

◆ clock

void* os_thread_attr_s::clock

Address of the clock to use for timeouts.

It may be os_clock_get_sysclock(), os_clock_get_rtclock(), or any other user object derived from class clock.

If NULL, the default is sysclock.

Definition at line 500 of file os-c-decls.h.

◆ th_priority

os_thread_prio_t os_thread_attr_s::th_priority

Thread initial priority.

If 0, the default is os_thread_priority_normal.

A convenient and explicit variant to this attribute is to call os_thread_set_priority() at the beginning of the thread function.

Definition at line 534 of file os-c-decls.h.

◆ th_stack_address

void* os_thread_attr_s::th_stack_address

Address of the user defined storage for the thread stack.

If NULL, the default is to dynamically allocate the stack.

Definition at line 508 of file os-c-decls.h.

◆ th_stack_size_bytes

size_t os_thread_attr_s::th_stack_size_bytes

Size of the user defined storage for the thread stack, in bytes.

If 0, the default is os_thread_stack_get_default_size().

A convenient and explicit variant to this attribute is to call os_thread_stack_set_default_size () just before creating the thread. However mind setting this from different threads at the same time.

Definition at line 522 of file os-c-decls.h.

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