Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/platform/ScopedLock.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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