Nicolas Borla / Mbed OS BBR_1Ebene

BBR 1 Ebene

mbed-os/platform/ScopedLock.h@0:fbdae7e6d805, 2018-05-14 (annotated)

Committer:
borlanic
Date:
Mon May 14 11:29:06 2018 +0000
Revision:
0:fbdae7e6d805
BBR

Who changed what in which revision?

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