1 /* mbed Microcontroller Library
2 * Copyright (c) 2006-2012 ARM Limited
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30 /** The Mutex class is used to synchronise the execution of threads.
31 This is for example used to protect access to a shared resource.
35 /** Create and Initialize a Mutex object */
38 /** Wait until a Mutex becomes available.
39 @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever)
40 @return status code that indicates the execution status of the function.
42 osStatus lock(uint32_t millisec=osWaitForever);
44 /** Try to lock the mutex, and return immediately
45 @return true if the mutex was acquired, false otherwise.
49 /** Unlock the mutex that has previously been locked by the same thread
50 @return status code that indicates the execution status of the function.
58 osMutexDef_t _osMutexDef;
60 int32_t _mutex_data[3];