recursive_mutex (Recursive Mutexes)

Overview

C++ utilities for the recursive_mutex (Recursive Mutexes) module.

WARNING: Recursive mutexes are rarely necessary for new code. They are often used to retrofit thread-safety into existing code. They can hide nasty bugs. Use regular etcpal::Mutex whenever possible.

Provides a C++ wrapper for the EtcPal recursive mutex type. Also provides an RAII guard classes for this type (RecursiveMutexGuard), which should be the primary constructs used to interact with the mutex class.

This class is similar to std::recursive_mutex, with the key advantage that it will work on any threaded platform that EtcPal is ported for, including the embedded RTOS platforms. If your application or library does not need to run on these platforms, consider using std::recursive_mutex instead.

Data Structures
class	RecursiveMutex
	A wrapper class for the EtcPal recursive mutex type. More...
class	RecursiveMutexGuard
	Lock guard around a recursive mutex. More...