CoreMutex Class Reference

Portable mutexes. More...

Static Public Member Functions
static CoreMutexHandle *	create ()
	Creates platform specific CoreMutex.
static void	wait_until_freed (CoreMutexHandle *mutex)
	Waits for ownership on the given mutex. This function will wait until the calling thread gets ownership on mutex.
static bool	release (CoreMutexHandle *mutex)
	Releases the incoming mutex.
static bool	destroy (CoreMutexHandle *mutex)
	Destroys the incoming mutex.
static bool	try_lock (CoreMutexHandle *mutex)
	Tries to acquire the incoming mutex. param[in] mutex valid mutex.

Detailed Description

Portable mutexes.

Member Function Documentation

CoreMutexHandle * CoreMutex::create ( )

static

Creates platform specific CoreMutex.

Returns

Handle if mutex creation was successful, 0 otherwise.

bool CoreMutex::destroy ( CoreMutexHandle *  mutex )

static

Destroys the incoming mutex.

Parameters

[in]

mutex

valid mutex. Must have been intialized with CoreMutex::create function

Returns

true if successful false otherwise.

bool CoreMutex::release ( CoreMutexHandle *  mutex )

static

Releases the incoming mutex.

Parameters

[in]

mutex

valid mutex.

Returns

true if successful, false otherwise.

bool CoreMutex::try_lock ( CoreMutexHandle *  mutex )

static

Tries to acquire the incoming mutex. param[in] mutex valid mutex.

Returns

true if mutex was acquired, false otherwise.

void CoreMutex::wait_until_freed ( CoreMutexHandle *  mutex )

static

Waits for ownership on the given mutex. This function will wait until the calling thread gets ownership on mutex.

Parameters

[in]

mutex

valid mutex