Mutex attributes. More...

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

Inheritance diagram for os::rtos::mutex::attributes:

Public Member Functions
Constructors & Destructor
constexpr	attributes ()
	Construct a mutex attributes object instance.

	attributes (const attributes &)=default

	attributes (attributes &&)=default

attributes &	operator= (const attributes &)=default

attributes &	operator= (attributes &&)=default

	~attributes ()=default
	Destruct the mutex attributes object instance.

Public Attributes
Public Member Variables
thread::priority_t	mx_priority_ceiling = thread::priority::highest
	Attribute with the mutex priority ceiling.

protocol_t	mx_protocol = protocol::default_
	Attribute with the mutex protocol.

robustness_t	mx_robustness = robustness::stalled
	Attribute with the mutex robustness.

type_t	mx_type = type::default_
	Attribute with the mutex type.

count_t	mx_max_count = max_count
	Attribute with the mutex maximum recursive count.

Public Member Variables
rtos::clock *	clock = nullptr
	Attribute with the address of the clock to be used for timeouts.

Detailed Description

Mutex attributes.

Allow to assign a name and custom attributes (like priority ceiling, robustness, etc) to the mutex.

To simplify access, the member variables are public and do not require accessors or mutators.

If the attributes are modified after the mutex creation, the mutex attributes shall not be affected.

POSIX compatibility: Inspired by pthread_mutexattr_t from <pthread.h> (IEEE Std 1003.1, 2013 Edition).

Definition at line 206 of file os-mutex.h.

Constructor & Destructor Documentation

◆ attributes() [1/3]

constexpr os::rtos::mutex::attributes::attributes ( )

constexpr

Construct a mutex attributes object instance.

Parameters: None.

Definition at line 795 of file os-mutex.h.

◆ attributes() [2/3]

os::rtos::mutex::attributes::attributes ( const attributes & )

default

◆ attributes() [3/3]

os::rtos::mutex::attributes::attributes ( attributes && )

default

◆ ~attributes()

os::rtos::mutex::attributes::~attributes ( )

default

Destruct the mutex attributes object instance.

Member Function Documentation

◆ operator=() [1/2]

attributes & os::rtos::mutex::attributes::operator= ( attributes && )

default

◆ operator=() [2/2]

attributes & os::rtos::mutex::attributes::operator= ( const attributes & )

default

Member Data Documentation

◆ clock

rtos::clock* os::rtos::internal::attributes_clocked::clock = nullptr

inherited

Attribute with the address of the clock to be used for timeouts.

It may be one of os::rtos::sysclock, os::rtos::rtclock, or any other user object derived from class os::rtos::clock.

If nullptr, the default clock is os::rtos::sysclock.

Definition at line 615 of file os-decls.h.

◆ mx_max_count

thread::priority_t os::rtos::mutex::attributes::mx_max_count = max_count

Attribute with the mutex maximum recursive count.

The mx_max_count attribute defines the upper limit of recursion for a recursive mutex. Further attempts to lock the mutex will result in EAGAIN.

Definition at line 287 of file os-mutex.h.

◆ mx_priority_ceiling

thread::priority_t os::rtos::mutex::attributes::mx_priority_ceiling = thread::priority::highest

Attribute with the mutex priority ceiling.

The mx_priority_ceiling attribute defines the priority ceiling of initialised mutexes, which is the minimum priority level at which the critical section guarded by the mutex is executed. In order to avoid priority inversion, the priority ceiling of the mutex shall be set to a priority higher than or equal to the highest priority of all the threads that may lock that mutex. The values of mx_priority_ceiling are within the maximum range of priorities defined under the SCHED_FIFO scheduling policy.