ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

RTOS: Mutex: Improve API docs

pull/4824/head
Bartek Szatkowski 2017-07-11 14:58:55 +01:00 committed by Martin Kojtal
parent 623c7ae625
commit efc28a2968
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
rtos/Mutex.h
View File

@ -53,17 +53,26 @@ public:
/** Wait until a Mutex becomes available. /** Wait until a Mutex becomes available.
@param millisec timeout value or 0 in case of no time-out. (default: osWaitForever) @param millisec timeout value or 0 in case of no time-out. (default: osWaitForever)
@return status code that indicates the execution status of the function. @return status code that indicates the execution status of the function:
@a osOK the mutex has been obtained.
@a osErrorTimeout the mutex could not be obtained in the given time.
@a osErrorParameter internal error.
@a osErrorResource the mutex could not be obtained when no timeout was specified.
@a osErrorISR this function cannot be called from the interrupt service routine.
*/ */
osStatus lock(uint32_t millisec=osWaitForever); osStatus lock(uint32_t millisec=osWaitForever);
/** Try to lock the mutex, and return immediately /** Try to lock the mutex, and return immediately
@return true if the mutex was acquired, false otherwise. @return true if the mutex was acquired, false otherwise.
*/ */
bool trylock(); bool trylock();
/** Unlock the mutex that has previously been locked by the same thread /** Unlock the mutex that has previously been locked by the same thread
@return status code that indicates the execution status of the function. @return status code that indicates the execution status of the function:
@a osOK the mutex has been released.
@a osErrorParameter internal error.
@a osErrorResource the mutex was not locked or the current thread wasn't the owner.
@a osErrorISR this function cannot be called from the interrupt service routine.
*/ */
osStatus unlock(); osStatus unlock();