cpp_freertos::CriticalSection Class Reference

#include <critical.hpp>

Static Public Member Functions
static void	DisableInterrupts ()
static void	EnableInterrupts ()
static void	Enter ()
static BaseType_t	EnterFromISR ()
static void	Exit ()
static void	ExitFromISR (BaseType_t savedInterruptStatus)
static void	ResumeScheduler ()
static void	SuspendScheduler ()

Detailed Description

Wrapper class around various critical section type synchronization mechanisms within FreeRTOS.

Member Function Documentation

DisableInterrupts()

static void cpp_freertos::CriticalSection::DisableInterrupts ( )

inlinestatic

Disable all maskable interrupts.

EnableInterrupts()

static void cpp_freertos::CriticalSection::EnableInterrupts ( )

inlinestatic

Enable all maskable interrupts.

Enter()

static void cpp_freertos::CriticalSection::Enter ( )

inlinestatic

Disable context switches as well as maskable interrupts.

EnterFromISR()

static BaseType_t cpp_freertos::CriticalSection::EnterFromISR ( )

inlinestatic

Disable context switches as well as maskable interrupts from an interrupt context.

Returns

Opaque representation of interrupt mask state. This must be passed back to the corresponding call to ExitFromISR().

Note

See the following for further details: http://www.freertos.org/taskENTER_CRITICAL_FROM_ISR_taskEXIT_CRITICAL_FROM_ISR.html

Exit()

static void cpp_freertos::CriticalSection::Exit ( )

inlinestatic

Re-enable context switches.

ExitFromISR()

static void cpp_freertos::CriticalSection::ExitFromISR ( BaseType_t  savedInterruptStatus )

inlinestatic

Re-enable context switches from an interrupt context.

Parameters

savedInterruptStatus

This should be the value you received from calling EnterFromISR().

Note

See the following for further details: http://www.freertos.org/taskENTER_CRITICAL_FROM_ISR_taskEXIT_CRITICAL_FROM_ISR.html

ResumeScheduler()

static void cpp_freertos::CriticalSection::ResumeScheduler ( )

inlinestatic

Re-enable the scheduler.

SuspendScheduler()

static void cpp_freertos::CriticalSection::SuspendScheduler ( )

inlinestatic

Suspend the scheduler without disabling interrupts.

---

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

• src/critical.hpp