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@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
Parent:
188:bcfe06ba3d64 
mbed library release version 165

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