os::rtos::semaphore::attributes_counting Class Reference

Counting semaphore attributes. More...

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

Inheritance diagram for os::rtos::semaphore::attributes_counting:

Public Member Functions
Constructors & Destructor
constexpr	attributes_counting (count_t max_value, count_t initial_value)
	Construct a counting semaphore attributes object instance.
	attributes_counting (const attributes_counting &)=default
	attributes_counting (attributes_counting &&)=default
attributes_counting &	operator= (const attributes_counting &)=default
attributes_counting &	operator= (attributes_counting &&)=default
	~attributes_counting ()=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

Counting semaphore attributes.

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

Constructor & Destructor Documentation

attributes_counting() [1/3]

constexpr os::rtos::semaphore::attributes_counting::attributes_counting ( count_t  max_value, count_t  initial_value  )

constexpr

Construct a counting semaphore attributes object instance.

Parameters

[in]	max_value	Maximum count value.
[in]	initial_value	Initial count value.

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

attributes_counting() [2/3]

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

default

attributes_counting() [3/3]

os::rtos::semaphore::attributes_counting::attributes_counting ( attributes_counting &&  )

default

~attributes_counting()

os::rtos::semaphore::attributes_counting::~attributes_counting ( )

default

Destruct the semaphore attributes object instance.

Member Function Documentation

operator=() [1/2]

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

default

operator=() [2/2]

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

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