ssi_pal_mutex

This file contains functions for resource management (mutex operations). The functions implementations are generally just wrappers to different operating system calls. None of the described functions will check the input parameters so the behavior of the APIs in illegal parameters case is dependent on the operating system behavior. More...

Functions
SaSiStatus	SaSi_PalMutexCreate (SaSi_PalMutex *pMutexId)
	This function purpose is to create a mutex. More...
SaSiStatus	SaSi_PalMutexDestroy (SaSi_PalMutex *pMutexId)
	This function purpose is to destroy a mutex. More...
SaSiStatus	SaSi_PalMutexLock (SaSi_PalMutex *pMutexId, uint32_t aTimeOut)
	This function purpose is to Wait for Mutex with aTimeOut. aTimeOut is specified in milliseconds (SASI_INFINITE is blocking). More...
SaSiStatus	SaSi_PalMutexUnlock (SaSi_PalMutex *pMutexId)
	This function purpose is to release the mutex. More...

Detailed Description

This file contains functions for resource management (mutex operations). The functions implementations are generally just wrappers to different operating system calls. None of the described functions will check the input parameters so the behavior of the APIs in illegal parameters case is dependent on the operating system behavior.

Function Documentation

SaSiStatus SaSi_PalMutexCreate

(

SaSi_PalMutex *

pMutexId

)

This function purpose is to create a mutex.

Returns

Zero on success.

A non-zero value on failure.

Parameters

[out]

pMutexId

Pointer to created mutex handle.

SaSiStatus SaSi_PalMutexDestroy

(

SaSi_PalMutex *

pMutexId

)

This function purpose is to destroy a mutex.

Returns

Zero on success.

A non-zero value on failure.

Parameters

[in]

pMutexId

Pointer to mutex handle.

SaSiStatus SaSi_PalMutexLock	(	SaSi_PalMutex *	pMutexId,
		uint32_t	aTimeOut
	)

This function purpose is to Wait for Mutex with aTimeOut. aTimeOut is specified in milliseconds (SASI_INFINITE is blocking).

Returns

Zero on success.

A non-zero value on failure.

Parameters

[in]	pMutexId	Pointer to Mutex handle.
[in]	aTimeOut	Timeout in mSec, or SASI_INFINITE.

SaSiStatus SaSi_PalMutexUnlock

(

SaSi_PalMutex *

pMutexId

)

This function purpose is to release the mutex.

Returns

Zero on success.

A non-zero value on failure.

Parameters

[in]

pMutexId

Pointer to Mutex handle.