Timothy Beight / Mbed 2 deprecated 6_songs-from-the-cloud

This is a fork due to permission issues

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of 6_songs-from-the-cloud by MakingMusicWorkshop

mbed-client/mbed-rtos/rtos/Mutex.h@1:0ddbe2d3319c, 2016-05-19 (annotated)

Committer:
timbeight
Date:
Thu May 19 16:02:10 2016 +0000
Revision:
1:0ddbe2d3319c
Parent:
0:f7c60d3e7b8a 
This is my first commit while in the class.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
maclobdell 0:f7c60d3e7b8a 1 /* mbed Microcontroller Library
maclobdell 0:f7c60d3e7b8a 2 * Copyright (c) 2006-2012 ARM Limited
maclobdell 0:f7c60d3e7b8a 3 *
maclobdell 0:f7c60d3e7b8a 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
maclobdell 0:f7c60d3e7b8a 5 * of this software and associated documentation files (the "Software"), to deal
maclobdell 0:f7c60d3e7b8a 6 * in the Software without restriction, including without limitation the rights
maclobdell 0:f7c60d3e7b8a 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
maclobdell 0:f7c60d3e7b8a 8 * copies of the Software, and to permit persons to whom the Software is
maclobdell 0:f7c60d3e7b8a 9 * furnished to do so, subject to the following conditions:
maclobdell 0:f7c60d3e7b8a 10 *
maclobdell 0:f7c60d3e7b8a 11 * The above copyright notice and this permission notice shall be included in
maclobdell 0:f7c60d3e7b8a 12 * all copies or substantial portions of the Software.
maclobdell 0:f7c60d3e7b8a 13 *
maclobdell 0:f7c60d3e7b8a 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
maclobdell 0:f7c60d3e7b8a 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
maclobdell 0:f7c60d3e7b8a 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
maclobdell 0:f7c60d3e7b8a 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
maclobdell 0:f7c60d3e7b8a 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
maclobdell 0:f7c60d3e7b8a 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
maclobdell 0:f7c60d3e7b8a 20 * SOFTWARE.
maclobdell 0:f7c60d3e7b8a 21 */
maclobdell 0:f7c60d3e7b8a 22 #ifndef MUTEX_H
maclobdell 0:f7c60d3e7b8a 23 #define MUTEX_H
maclobdell 0:f7c60d3e7b8a 24
maclobdell 0:f7c60d3e7b8a 25 #include <stdint.h>
maclobdell 0:f7c60d3e7b8a 26 #include "cmsis_os.h"
maclobdell 0:f7c60d3e7b8a 27
maclobdell 0:f7c60d3e7b8a 28 namespace rtos {
maclobdell 0:f7c60d3e7b8a 29
maclobdell 0:f7c60d3e7b8a 30 /** The Mutex class is used to synchronise the execution of threads.
maclobdell 0:f7c60d3e7b8a 31 This is for example used to protect access to a shared resource.
maclobdell 0:f7c60d3e7b8a 32 */
maclobdell 0:f7c60d3e7b8a 33 class Mutex {
maclobdell 0:f7c60d3e7b8a 34 public:
maclobdell 0:f7c60d3e7b8a 35 /** Create and Initialize a Mutex object */
maclobdell 0:f7c60d3e7b8a 36 Mutex();
maclobdell 0:f7c60d3e7b8a 37
maclobdell 0:f7c60d3e7b8a 38 /** Wait until a Mutex becomes available.
maclobdell 0:f7c60d3e7b8a 39 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever)
maclobdell 0:f7c60d3e7b8a 40 @return status code that indicates the execution status of the function.
maclobdell 0:f7c60d3e7b8a 41 */
maclobdell 0:f7c60d3e7b8a 42 osStatus lock(uint32_t millisec=osWaitForever);
maclobdell 0:f7c60d3e7b8a 43
maclobdell 0:f7c60d3e7b8a 44 /** Try to lock the mutex, and return immediately
maclobdell 0:f7c60d3e7b8a 45 @return true if the mutex was acquired, false otherwise.
maclobdell 0:f7c60d3e7b8a 46 */
maclobdell 0:f7c60d3e7b8a 47 bool trylock();
maclobdell 0:f7c60d3e7b8a 48
maclobdell 0:f7c60d3e7b8a 49 /** Unlock the mutex that has previously been locked by the same thread
maclobdell 0:f7c60d3e7b8a 50 @return status code that indicates the execution status of the function.
maclobdell 0:f7c60d3e7b8a 51 */
maclobdell 0:f7c60d3e7b8a 52 osStatus unlock();
maclobdell 0:f7c60d3e7b8a 53
maclobdell 0:f7c60d3e7b8a 54 ~Mutex();
maclobdell 0:f7c60d3e7b8a 55
maclobdell 0:f7c60d3e7b8a 56 private:
maclobdell 0:f7c60d3e7b8a 57 osMutexId _osMutexId;
maclobdell 0:f7c60d3e7b8a 58 osMutexDef_t _osMutexDef;
maclobdell 0:f7c60d3e7b8a 59 #ifdef CMSIS_OS_RTX
maclobdell 0:f7c60d3e7b8a 60 #ifdef __MBED_CMSIS_RTOS_CA9
maclobdell 0:f7c60d3e7b8a 61 int32_t _mutex_data[4];
maclobdell 0:f7c60d3e7b8a 62 #else
maclobdell 0:f7c60d3e7b8a 63 int32_t _mutex_data[3];
maclobdell 0:f7c60d3e7b8a 64 #endif
maclobdell 0:f7c60d3e7b8a 65 #endif
maclobdell 0:f7c60d3e7b8a 66 };
maclobdell 0:f7c60d3e7b8a 67
maclobdell 0:f7c60d3e7b8a 68 }
maclobdell 0:f7c60d3e7b8a 69 #endif