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

Locker meeting the standard Lockable requirements (30.2.5.3).

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

Constructor & Destructor Documentation

lockable()

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

constexpr

Parameters

None.

Note

Can be invoked from Interrupt Service Routines.

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

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

~lockable()

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

inline

Note

Can be invoked from Interrupt Service Routines.

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

      {
      }

Member Function Documentation

lock()

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

inline

Parameters

None.

Returns

Nothing.

Note

Can be invoked from Interrupt Service Routines.

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

      {
        state_ = critical_section::enter ();
      }

References os::rtos::interrupts::critical_section::enter().

try_lock()

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

inline

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 1213 of file os-sched.h.

      {
        state_ = critical_section::enter ();
        return true;
      }

References os::rtos::interrupts::critical_section::enter().

unlock()

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

inline

Parameters

None.

Returns

Nothing.

Note

Can be invoked from Interrupt Service Routines.

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

      {
        critical_section::exit (state_);
      }

References os::rtos::interrupts::critical_section::exit().

---

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

• os-sched.h