FreeRTOS C++ Wrappers
Public Member Functions | List of all members
Semaphore Class Reference

Binary Semaphore Wrapper. More...

#include <SemaphoreCPP.h>

Collaboration diagram for Semaphore:
Collaboration graph

Public Member Functions

 Semaphore (char const *name)
 Constructor. More...
 
 ~Semaphore ()
 Destructor. More...
 
signed portBASE_TYPE give ()
 Give the Semaphore. More...
 
signed portBASE_TYPE take (TickType_t delay=portMAX_DELAY)
 Take the semaphore. More...
 
signed portBASE_TYPE give_ISR (portBASE_TYPE &waswoken)
 Give the Semaphore inside an ISR. More...
 

Detailed Description

Binary Semaphore Wrapper.

Constructor & Destructor Documentation

Semaphore::Semaphore ( char const *  name)
inline

Constructor.

Parameters
nameName to give semaphore, used for Debug Registry if setup
Semaphore::~Semaphore ( )
inline

Destructor.

Delete the semaphore.

Member Function Documentation

signed portBASE_TYPE Semaphore::give ( )
inline

Give the Semaphore.

signed portBASE_TYPE Semaphore::give_ISR ( portBASE_TYPE &  waswoken)
inline

Give the Semaphore inside an ISR.

Parameters
waswokenThe flag variable used to indicate if we need to run the scheduler when we exit the ISR.
signed portBASE_TYPE Semaphore::take ( TickType_t  delay = portMAX_DELAY)
inline

Take the semaphore.

Parameters
delayThe number of ticks to wait for the semaphore

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