Thomas Lyp / DevLibMemoryController

Initial commit

Dependencies:   FastPWM

mbed-dev-master/platform/ScopedLock.h@0:bb348c97df44, 2020-09-16 (annotated)

Committer:
lypinator
Date:
Wed Sep 16 01:11:49 2020 +0000
Revision:
0:bb348c97df44
Added PWM

Who changed what in which revision?

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