µ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::interrupts::lockable Class Reference

Interrupts standard locker. More...

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

Public Member Functions

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

Detailed Description

Interrupts standard locker.

Locker meeting the standard Lockable requirements (30.2.5.3).

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

Constructor & Destructor Documentation

◆ lockable()

constexpr os::rtos::interrupts::lockable::lockable ( )

Construct an interrupts lock.

Parameters
None.
Note
Can be invoked from Interrupt Service Routines.

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

◆ ~lockable()

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

Destruct the interrupts lock.

Note
Can be invoked from Interrupt Service Routines.

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

Member Function Documentation

◆ lock()

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

Lock the interrupts.

Parameters
None.
Returns
Nothing.
Note
Can be invoked from Interrupt Service Routines.

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

◆ try_lock()

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

Try to lock the interrupts.

Parameters
None.
Return values
trueThe interrupts were locked.

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

Note
Can be invoked from Interrupt Service Routines.

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

◆ unlock()

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

Unlock the interrupts.

Parameters
None.
Returns
Nothing.
Note
Can be invoked from Interrupt Service Routines.

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


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