µOS++ IIIe Reference  v6.3.15
“Perfekt ist nicht gut genug”
The third edition of µOS++, a POSIX inspired open source system, written in C++.
os::rtos::scheduler::lockable Class Reference

Scheduler standard locker. More...

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

Public Member Functions

Constructors & Destructor
constexpr lockable ()
 Construct a lockable object instance. More...
 
 ~lockable ()
 Destruct the lockable object instance. More...
 
Public Member Functions
void lock (void)
 Lock the scheduler. More...
 
bool try_lock (void)
 Try to lock the scheduler. More...
 
void unlock (void)
 Unlock the scheduler. More...
 

Detailed Description

Scheduler standard locker.

Locker meeting the standard Lockable requirements (30.2.5.3).

Definition at line 314 of file os-sched.h.

Constructor & Destructor Documentation

◆ lockable()

constexpr os::rtos::scheduler::lockable::lockable ( )

Construct a lockable object instance.

Parameters
None.
Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 972 of file os-sched.h.

◆ ~lockable()

os::rtos::scheduler::lockable::~lockable ( )
inline

Destruct the lockable object instance.

Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 984 of file os-sched.h.

Member Function Documentation

◆ lock()

void os::rtos::scheduler::lockable::lock ( void  )
inline

Lock the scheduler.

Parameters
None.
Returns
Nothing.
Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 995 of file os-sched.h.

◆ try_lock()

bool os::rtos::scheduler::lockable::try_lock ( void  )
inline

Try to lock the scheduler.

Parameters
None.
Return values
trueThe scheduler was locked.

Somehow redundant, since the lock will always succeed; but used to meet the lockableable requirements.

Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 1008 of file os-sched.h.

◆ unlock()

void os::rtos::scheduler::lockable::unlock ( void  )
inline

Unlock the scheduler.

Parameters
None.
Returns
Nothing.
Warning
Cannot be invoked from Interrupt Service Routines.

Definition at line 1020 of file os-sched.h.


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