|void||OSMUTEX_Destroy (OSMutex mutex)|
|bool||OSMUTEX_IsValid (OSMutex mutex)|
|void||OSMUTEX_Give (OSMutex mutex)|
|int||OSMUTEX_Take (OSMutex mutex, OSTime timeout)|
An interface to a mutual exclusion semaphore (mutex) mechanism provided by the OS. The implementation of the OSMutex depends on the OS used, however the mutex is guaranteed to be non-recursive.
Creates a new mutex instance. This mutex is non-recursive. The mutex implementation depends on the actual OS. A newly created mutex has no owner, it is available to be taken through a call to OSMUTEX_Take.
- a newly created mutex
Destroys a mutex
mutex mutex to destroy
Gives the mutex.
mutex mutex to give
Checks if a mutex handle represents a valid mutex. Can be used to test if OSMUTEX_Create produced a valid mutex. Beware, that checking handle of a mutex, that has been destroyed (OSMUTEX_Destroy) yields undefined behavior. On some ports such handle may still be reported as valid.
mutex mutex to check
- true if mutex is valid or false if not
Takes the mutex. If the mutex is not immediately available, the task from which the call was made is blocked. The maximum time spent waiting for the mutex is specified by the timeout parameter.
mutex mutex to take timeout maximum time spent waiting for the mutex in miliseconds
- 0 if the mutex was taken !0 if timeout or error occurred
Generated on Thu Feb 22 2018 13:14:55 for RCM API C++ Library by 184.108.40.206