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

Detailed Description

Locker meeting the standard Lockable requirements (30.2.5.3).

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

Constructor & Destructor Documentation

lockable()

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

constexpr

Parameters

None.

Warning

Cannot be invoked from Interrupt Service Routines.

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

                                    : state_ (port::scheduler::state::init)
      {
      }

~lockable()

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

inline

Warning

Cannot be invoked from Interrupt Service Routines.

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

      {
      }

Member Function Documentation

lock()

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

inline

Parameters

None.

Returns

Nothing.

Warning

Cannot be invoked from Interrupt Service Routines.

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

      {
        state_ = scheduler::lock ();
      }

References os::rtos::scheduler::lock().

try_lock()

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

inline

Parameters

None.

Return values

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

      {
        state_ = scheduler::lock ();
        return true;
      }

References os::rtos::scheduler::lock().

unlock()

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

inline

Parameters

None.

Returns

Nothing.

Warning

Cannot be invoked from Interrupt Service Routines.

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

      {
        scheduler::locked (state_);
      }

References os::rtos::scheduler::locked().

---

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

• os-sched.h