roo_threads::doc::thread::attributes Class Reference

Optional thread attributes used by backend-specific constructors. More...

#include <thread_api.h>

Public Member Functions
	attributes ()
	Creates default thread attributes.
uint32_t	stack_size () const
	Returns requested stack size in bytes.
uint16_t	priority () const
	Returns requested scheduler priority.
bool	joinable () const
	Returns whether the created thread is joinable.
const char *	name () const
	Returns thread name, or nullptr if not set.
void	set_stack_size (uint32_t stack_size)
	Sets requested stack size in bytes.
void	set_priority (uint16_t priority)
	Sets requested scheduler priority.
void	set_name (const char *name)
	Sets thread name.

Detailed Description

Optional thread attributes used by backend-specific constructors.

Definition at line 21 of file thread_api.h.

Constructor & Destructor Documentation

attributes()

roo_threads::doc::thread::attributes::attributes

(

)

Creates default thread attributes.

Member Function Documentation

joinable()

bool roo_threads::doc::thread::attributes::joinable

(

)

const

Returns whether the created thread is joinable.

name()

const char * roo_threads::doc::thread::attributes::name

(

)

const

Returns thread name, or nullptr if not set.

priority()

uint16_t roo_threads::doc::thread::attributes::priority

(

)

const

Returns requested scheduler priority.

set_name()

void roo_threads::doc::thread::attributes::set_name

(

const char *

name

)

Sets thread name.

Parameters

name	zero-terminated name string.

set_priority()

void roo_threads::doc::thread::attributes::set_priority

(

uint16_t

priority

)

Sets requested scheduler priority.

Parameters

priority

scheduler priority.

set_stack_size()

void roo_threads::doc::thread::attributes::set_stack_size

(

uint32_t

stack_size

)

Sets requested stack size in bytes.

Parameters

stack_size

stack size in bytes.

stack_size()

uint32_t roo_threads::doc::thread::attributes::stack_size

(

)

const

Returns requested stack size in bytes.

---

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

• temp_repos/roo_threads/src/roo_threads/doc/thread_api.h