Rtos API example

Embed: (wiki syntax)

« Back to documentation index

DeepSleepLock Class Reference

DeepSleepLock Class Reference
[DeepSleepLock functions]

RAII object for disabling, then restoring the deep sleep mode Usage: More...

#include <DeepSleepLock.h>

Public Member Functions

void lock ()
 Mark the start of a locked deep sleep section.
void unlock ()
 Mark the end of a locked deep sleep section.

Detailed Description

RAII object for disabling, then restoring the deep sleep mode Usage:

 void f() {
     // some code here
     {
         DeepSleepLock lock;
         // Code in this block will run with the deep sleep mode locked
     }
     // deep sleep mode will be restored to their previous state
 }

Definition at line 46 of file DeepSleepLock.h.


Member Function Documentation

void lock ( void   )

Mark the start of a locked deep sleep section.

Definition at line 65 of file DeepSleepLock.h.

void unlock ( void   )

Mark the end of a locked deep sleep section.

Definition at line 78 of file DeepSleepLock.h.