cpp_freertos::CriticalSection Class Reference

#include <critical.hpp>

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

Detailed Description

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

Definition at line 54 of file critical.hpp.

Member Function Documentation

DisableInterrupts()

static void cpp_freertos::CriticalSection::DisableInterrupts ( )

inlinestatic

Disable all maskable interrupts.

Definition at line 112 of file critical.hpp.

EnableInterrupts()

static void cpp_freertos::CriticalSection::EnableInterrupts ( )

inlinestatic

Enable all maskable interrupts.

Definition at line 120 of file critical.hpp.

Enter()

static void cpp_freertos::CriticalSection::Enter ( )

inlinestatic

Disable context switches as well as maskable interrupts.

Definition at line 66 of file critical.hpp.

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

Definition at line 90 of file critical.hpp.

Exit()

static void cpp_freertos::CriticalSection::Exit ( )

inlinestatic

Re-enable context switches.

Definition at line 74 of file critical.hpp.

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

Definition at line 104 of file critical.hpp.

ResumeScheduler()

static void cpp_freertos::CriticalSection::ResumeScheduler ( )

inlinestatic

Re-enable the scheduler.

Definition at line 136 of file critical.hpp.

SuspendScheduler()

static void cpp_freertos::CriticalSection::SuspendScheduler ( )

inlinestatic

Suspend the scheduler without disabling interrupts.

Definition at line 128 of file critical.hpp.

---

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

• critical.hpp