Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/platform/ScopedLock.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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