rtos: Add ScopedMutexLock typedef

2018-01-15 07:59:30 +01:00 · 2018-01-15 07:59:30 +01:00 · cde5196170
parent a3c9c124f7
commit cde5196170
1 changed files with 15 additions and 0 deletions
--- a/rtos/Mutex.h
+++ b/rtos/Mutex.h
@ -28,10 +28,25 @@
 #include "mbed_rtos_storage.h"

 #include "platform/NonCopyable.h"
+#include "platform/ScopedLock.h"

 namespace rtos {
 /** \addtogroup rtos */
 /** @{*/
+
+class Mutex;
+/** Typedef for the mutex lock
+ *
+ * Usage:
+ * @code
+ * void foo(Mutex &m) {
+ *     ScopedMutexLock lock(m);
+ *     // Code in this block will be protected by Mutex lock
+ * }
+ * @endcode
+ */
+typedef mbed::ScopedLock<Mutex> ScopedMutexLock;
+
 /**
 * \defgroup rtos_Mutex Mutex class
 * @{