os::rtos::semaphore::attributes_binary Class Reference

Binary semaphore attributes. More...

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

Inheritance diagram for os::rtos::semaphore::attributes_binary:

Public Member Functions
Constructors & Destructor
constexpr	attributes_binary (count_t initial_value)
	Construct a binary semaphore attributes object instance.
	attributes_binary (const attributes_binary &)=default
	attributes_binary (attributes_binary &&)=default
attributes_binary &	operator= (const attributes_binary &)=default
attributes_binary &	operator= (attributes_binary &&)=default
	~attributes_binary ()=default
	Destruct the semaphore attributes object instance.

Public Attributes
Public Member Variables
count_t	sm_max_value = 1
	Semaphore max count value.
count_t	sm_initial_value = 0
	Semaphore initial count value.
Public Member Variables
rtos::clock *	clock = nullptr
	Attribute with the address of the clock to be used for timeouts.

Detailed Description

Binary semaphore attributes.

Definition at line 174 of file os-semaphore.h.

Constructor & Destructor Documentation

attributes_binary() [1/3]

constexpr os::rtos::semaphore::attributes_binary::attributes_binary ( count_t  initial_value )

constexpr

Construct a binary semaphore attributes object instance.

Parameters

[in]

initial_value

Initial count value.

Definition at line 700 of file os-semaphore.h.

attributes_binary() [2/3]

os::rtos::semaphore::attributes_binary::attributes_binary ( const attributes_binary &  )

default

attributes_binary() [3/3]

os::rtos::semaphore::attributes_binary::attributes_binary ( attributes_binary &&  )

default

~attributes_binary()

os::rtos::semaphore::attributes_binary::~attributes_binary ( )

default

Destruct the semaphore attributes object instance.

Member Function Documentation

operator=() [1/2]

attributes_binary & os::rtos::semaphore::attributes_binary::operator= ( attributes_binary &&  )

default

operator=() [2/2]

attributes_binary & os::rtos::semaphore::attributes_binary::operator= ( const attributes_binary &  )

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 629 of file os-decls.h.

sm_initial_value

semaphore::count_t os::rtos::semaphore::attributes::sm_initial_value = 0

inherited

Semaphore initial count value.

This values represents the number of resources initially available to the semaphore.

Definition at line 158 of file os-semaphore.h.

sm_max_value

semaphore::count_t os::rtos::semaphore::attributes::sm_max_value = 1

inherited

Semaphore max count value.

This values represents the maximum number of resources available to the semaphore.

Definition at line 153 of file os-semaphore.h.

---

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

• os-semaphore.h