BA / Mbed OS BaBoRo_test2

Backup 1

mbed-os/platform/ScopedLock.h@0:02dd72d1d465, 2018-04-24 (annotated)

Committer:
borlanic
Date:
Tue Apr 24 11:45:18 2018 +0000
Revision:
0:02dd72d1d465
BaBoRo_test2 - backup 1

Who changed what in which revision?

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