os::rtos::interrupts::critical_section Class Reference

Interrupts critical section RAII helper. More...

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

Public Member Functions
Constructors & Destructor
	critical_section ()
	Enter an interrupts critical section.
	~critical_section ()
	Exit the interrupts critical section.

Static Public Member Functions
Public Member Functions
static state_t	enter (void)
	Enter an interrupts critical section.
static void	exit (state_t state)
	Exit the interrupts critical section.

Detailed Description

Use this class to define a critical section protected to interrupts service routines. The beginning of the critical section is exactly the place where this class is instantiated (the constructor will disable interrupts below the scheduler priority). The end of the critical section is the end of the surrounding block (the destructor will enable the interrupts).

Note

Can be nested as many times as required without problems, only the outer call will re-enable the interrupts.

Example

void
func(void)
{
   // Do something
 
   {
     interrupts::critical_section ics;  // Critical section begins
here.
 
     // Inside the critical section.
     // No scheduler switches will happen here.
 
   } // Critical section ends here.
 
   // Do something else.
}

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

Constructor & Destructor Documentation

critical_section()

os::rtos::interrupts::critical_section::critical_section ( )

inline

Parameters

None.

Note

Can be invoked from Interrupt Service Routines.

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

          : state_ (enter ())
      {
      }

~critical_section()

os::rtos::interrupts::critical_section::~critical_section ( )

inline

Note

Can be invoked from Interrupt Service Routines.

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

      {
        exit (state_);
      }

References exit().

Member Function Documentation

enter()

state_t os::rtos::interrupts::critical_section::enter ( void  )

inlinestatic

Parameters

None.

Returns

The previous value of the interrupts priorities register.

Note

Can be invoked from Interrupt Service Routines.

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

      {
        return port::interrupts::critical_section::enter ();
      }

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

Referenced by os::rtos::interrupts::lockable::lock(), os_irq_critical_enter(), and os::rtos::interrupts::lockable::try_lock().

exit()

void os::rtos::interrupts::critical_section::exit ( state_t  state )

inlinestatic

Parameters

state

The value to restore the interrupts priorities register.

Returns

Nothing.

Note

Can be invoked from Interrupt Service Routines.

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

      {
        port::interrupts::critical_section::exit (state);
      }

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

Referenced by ~critical_section(), os_irq_critical_exit(), and os::rtos::interrupts::lockable::unlock().

---

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

• os-sched.h