OSUnlockMutex

Syntax

#include <cafe/os.h>

void OSUnlockMutex (OSMutex* mutex);

Parameters

mutex Pointer to mutex.

Return Values

None.

Description

The calling thread unlocks the mutex. The calling thread must own the mutex. If the calling thread has locked this mutex n times, the mutex will only be unlocked on the nth call to the OSUnLockMutex function. If the calling thread had a temporarily higher priority because a higher priority thread requested this mutex, the priority will be recalculated (may not result in the standard priority because it depends on other mutexes that are retained). If the mutex is unlocked, all threads that this mutex blocks get executable status and execute according to priority.

Do Not Call From

Callbacks Do not call this function from any callback function.

See Also

OSInitCond
OSInitMutex
OSLockMutex
OSSignalCond
OSTryLockMutex
OSWaitCond

Revision History

2013-05-08 Automated cleanup pass.
2012-08-01 Cleanup pass.
2010-08-30 Initial version.


CONFIDENTIAL