#include <mutex.hpp>
Inheritance diagram for cpp_freertos::Mutex:
Public Member Functions | |
| virtual bool | Lock (TickType_t Timeout=portMAX_DELAY)=0 |
| virtual bool | Unlock ()=0 |
| virtual | ~Mutex () |
Protected Member Functions | |
| Mutex () | |
Protected Attributes | |
| SemaphoreHandle_t | handle |
Detailed Description
Base wrapper class around FreeRTOS's implementation of mutexes.
By definition, Mutexes can NOT be used from ISR contexts.
- Note
- It is expected that an application will instantiate one of the derived classes and use that object for synchronization. It is not expected that a user or application will derive from these classes.
Constructor & Destructor Documentation
◆ ~Mutex()
|
virtual |
Our destructor
Definition at line 51 of file cmutex.cpp.
◆ Mutex()
|
protected |
This constructor should not be public.
Definition at line 46 of file cmutex.cpp.
Member Function Documentation
◆ Lock()
|
pure virtual |
Lock the Mutex.
Each type of Mutex implements it's own locking code as per the FreeRTOS API.
- Parameters
-
Timeout How long to wait to get the Lock until giving up.
- Returns
- true if the Lock was acquired, false if it timed out.
Implemented in cpp_freertos::MutexRecursive, and cpp_freertos::MutexStandard.
◆ Unlock()
|
pure virtual |
Unlock the Mutex.
- Returns
- true if the Lock was released, false if it failed. (Hint, if it fails, did you call Lock() first?)
Implemented in cpp_freertos::MutexRecursive, and cpp_freertos::MutexStandard.
Member Data Documentation
◆ handle
|
protected |
The documentation for this class was generated from the following files:
