BA / Mbed OS BaBoRo1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/platform/ScopedLock.h@0:380207fcb5c1, 2018-03-29 (annotated)

Committer:
borlanic
Date:
Thu Mar 29 07:02:09 2018 +0000
Revision:
0:380207fcb5c1
Encoder, IMU --> OK; Controller --> in bearbeitung

Who changed what in which revision?

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