#include <semaphore.hpp>
Inheritance diagram for cpp_freertos::CountingSemaphore:
Public Member Functions | |
| CountingSemaphore (UBaseType_t maxCount, UBaseType_t initialCount) | |
 Public Member Functions inherited from cpp_freertos::Semaphore | |
| virtual | ~Semaphore () |
| bool | Give () |
| bool | GiveFromISR (BaseType_t *pxHigherPriorityTaskWoken) |
| bool | Take (TickType_t Timeout=portMAX_DELAY) |
| bool | TakeFromISR (BaseType_t *pxHigherPriorityTaskWoken) |
Additional Inherited Members | |
| Protected Member Functions inherited from cpp_freertos::Semaphore | |
| Semaphore () | |
| Protected Attributes inherited from cpp_freertos::Semaphore | |
| SemaphoreHandle_t | handle |
Detailed Description
Wrapper class for Counting Semaphores.
Constructor & Destructor Documentation
◆ CountingSemaphore()
| CountingSemaphore::CountingSemaphore | ( | UBaseType_t | maxCount, |
| UBaseType_t | initialCount | ||
| ) |
Constructor to create a counting semaphore. This ctor throws a SemaphoreCreateException on failure.
- Parameters
-
maxCount Must be greater than 0. initialCount Must not be greater than maxCount.
- Exceptions
-
SemaphoreCreateException on failure.
- Returns
- Instance of a CountingSemaphore.
The documentation for this class was generated from the following files:
- src/semaphore.hpp
- src/freertos-addon/c++/csemaphore.cpp
