Austin Blackstone / Mbed 2 deprecated mbed-client-classic-example-lwip

mbed client on ethernet with LWIP

Dependencies:   mbed Socket lwip-eth lwip-sys lwip

Fork of mbed-client-classic-example-lwip by sandbox

mbed-rtos/rtos/Mutex.h@11:cada08fc8a70, 2016-06-09 (annotated)

Committer:
mbedAustin
Date:
Thu Jun 09 17:08:36 2016 +0000
Revision:
11:cada08fc8a70
Commit for public Consumption

Who changed what in which revision?

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