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.
	~lockable ()
	Destruct the interrupts lock.
Public Member Functions
void	lock (void)
	Lock the interrupts.
bool	try_lock (void)
	Try to lock the interrupts.
void	unlock (void)
	Unlock the interrupts.

Detailed Description

Interrupts standard locker.

Locker meeting the standard Lockable requirements (30.2.5.3).

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

Constructor & Destructor Documentation

lockable()

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

constexpr

Construct an interrupts lock.

Parameters

None.

Note

Can be invoked from Interrupt Service Routines.

Definition at line 1231 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 1242 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 1252 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

true	The 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 1266 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 1277 of file os-sched.h.

---

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

• os-sched.h