mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/ScopedLock.h@187:0387e8f68319, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:40:20 2018 +0100
Revision:
187:0387e8f68319
Parent:
184:08ed48f1de7f
Child:
188:bcfe06ba3d64
mbed-dev library. Release version 163

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 184:08ed48f1de7f 1 /* mbed Microcontroller Library
AnnaBridge 184:08ed48f1de7f 2 * Copyright (c) 2018 ARM Limited
AnnaBridge 184:08ed48f1de7f 3 *
AnnaBridge 184:08ed48f1de7f 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 184:08ed48f1de7f 5 * you may not use this file except in compliance with the License.
AnnaBridge 184:08ed48f1de7f 6 * You may obtain a copy of the License at
AnnaBridge 184:08ed48f1de7f 7 *
AnnaBridge 184:08ed48f1de7f 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 184:08ed48f1de7f 9 *
AnnaBridge 184:08ed48f1de7f 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 184:08ed48f1de7f 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 184:08ed48f1de7f 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 184:08ed48f1de7f 13 * See the License for the specific language governing permissions and
AnnaBridge 184:08ed48f1de7f 14 * limitations under the License.
AnnaBridge 184:08ed48f1de7f 15 */
AnnaBridge 184:08ed48f1de7f 16 #ifndef MBED_SCOPEDLOCK_H
AnnaBridge 184:08ed48f1de7f 17 #define MBED_SCOPEDLOCK_H
AnnaBridge 184:08ed48f1de7f 18
AnnaBridge 184:08ed48f1de7f 19 #include "platform/NonCopyable.h"
AnnaBridge 184:08ed48f1de7f 20
AnnaBridge 184:08ed48f1de7f 21 namespace mbed {
AnnaBridge 184:08ed48f1de7f 22
AnnaBridge 184:08ed48f1de7f 23 /** \addtogroup platform */
AnnaBridge 184:08ed48f1de7f 24 /** @{*/
AnnaBridge 184:08ed48f1de7f 25 /**
AnnaBridge 184:08ed48f1de7f 26 * \defgroup platform_ScopedLock ScopedLock functions
AnnaBridge 184:08ed48f1de7f 27 * @{
AnnaBridge 184:08ed48f1de7f 28 */
AnnaBridge 184:08ed48f1de7f 29
AnnaBridge 184:08ed48f1de7f 30 /** RAII-style mechanism for owning a lock of Lockable object for the duration of a scoped block
AnnaBridge 184:08ed48f1de7f 31 *
AnnaBridge 184:08ed48f1de7f 32 * @tparam Lockable The type implementing BasicLockable concept
AnnaBridge 184:08ed48f1de7f 33 *
AnnaBridge 184:08ed48f1de7f 34 * @note For type Lockable to be BasicLockable, the following conditions have to be satisfied:
AnnaBridge 184:08ed48f1de7f 35 * - has public member function @a lock which blocks until a lock can be obtained for the current execution context
AnnaBridge 184:08ed48f1de7f 36 * - has public member function @a unlock which releases the lock
AnnaBridge 184:08ed48f1de7f 37 *
AnnaBridge 184:08ed48f1de7f 38 * Usage:
AnnaBridge 184:08ed48f1de7f 39 *
AnnaBridge 184:08ed48f1de7f 40 * Example with rtos::Mutex
AnnaBridge 184:08ed48f1de7f 41 *
AnnaBridge 184:08ed48f1de7f 42 * @code
AnnaBridge 184:08ed48f1de7f 43 * void foo(Mutex &m) {
AnnaBridge 184:08ed48f1de7f 44 * ScopedLock<Mutex> lock(m);
AnnaBridge 184:08ed48f1de7f 45 * // Mutex lock protects code in this block
AnnaBridge 184:08ed48f1de7f 46 * }
AnnaBridge 184:08ed48f1de7f 47 * @endcode
AnnaBridge 184:08ed48f1de7f 48 *
AnnaBridge 184:08ed48f1de7f 49 *
AnnaBridge 184:08ed48f1de7f 50 * More generic example
AnnaBridge 184:08ed48f1de7f 51 *
AnnaBridge 184:08ed48f1de7f 52 * @code
AnnaBridge 184:08ed48f1de7f 53 * template<typename Lockable>
AnnaBridge 184:08ed48f1de7f 54 * void foo(Lockable& lockable) {
AnnaBridge 184:08ed48f1de7f 55 * ScopedLock<Lockable> lock(lockable);
AnnaBridge 184:08ed48f1de7f 56 * // Code in this block runs under lock
AnnaBridge 184:08ed48f1de7f 57 * }
AnnaBridge 184:08ed48f1de7f 58 * @endcode
AnnaBridge 184:08ed48f1de7f 59 */
AnnaBridge 184:08ed48f1de7f 60 template <typename Lockable>
AnnaBridge 184:08ed48f1de7f 61 class ScopedLock : private NonCopyable<ScopedLock<Lockable> > {
AnnaBridge 184:08ed48f1de7f 62 public:
AnnaBridge 184:08ed48f1de7f 63 /** Locks given locable object
AnnaBridge 184:08ed48f1de7f 64 *
AnnaBridge 184:08ed48f1de7f 65 * @param lockable reference to the instance of Lockable object
AnnaBridge 184:08ed48f1de7f 66 * @note lockable object should outlive the ScopedLock object
AnnaBridge 184:08ed48f1de7f 67 */
AnnaBridge 187:0387e8f68319 68 ScopedLock(Lockable &lockable): _lockable(lockable)
AnnaBridge 184:08ed48f1de7f 69 {
AnnaBridge 184:08ed48f1de7f 70 _lockable.lock();
AnnaBridge 184:08ed48f1de7f 71 }
AnnaBridge 184:08ed48f1de7f 72
AnnaBridge 184:08ed48f1de7f 73 ~ScopedLock()
AnnaBridge 184:08ed48f1de7f 74 {
AnnaBridge 184:08ed48f1de7f 75 _lockable.unlock();
AnnaBridge 184:08ed48f1de7f 76 }
AnnaBridge 184:08ed48f1de7f 77 private:
AnnaBridge 187:0387e8f68319 78 Lockable &_lockable;
AnnaBridge 184:08ed48f1de7f 79 };
AnnaBridge 184:08ed48f1de7f 80
AnnaBridge 184:08ed48f1de7f 81 /**@}*/
AnnaBridge 184:08ed48f1de7f 82
AnnaBridge 184:08ed48f1de7f 83 /**@}*/
AnnaBridge 184:08ed48f1de7f 84
AnnaBridge 184:08ed48f1de7f 85 } // embed
AnnaBridge 184:08ed48f1de7f 86
AnnaBridge 184:08ed48f1de7f 87 #endif // MBED_SCOPEDLOCK_H