Skip to main content

Functions

ar_osal_mutex_init

Initializes a mutex. Memory for mutex object is created by client and this API is used to initialize the mutex. Recursive mutexes are always used. @datatypes ar_osal_mutex_t
Parameters
ar_osal_mutex_t
Pointer to the mutex object handle.
Returns 0 Success Nonzero Failure

ar_osal_mutex_deinit

De-initializes a mutex. Mutex memory was provided by client and this API is used to de-initialize the mutex before freeing the object. @datatypes ar_osal_mutex_t
Parameters
ar_osal_mutex_t
Pointer to the mutex object handle.
Returns 0 Success Nonzero Failure

ar_osal_mutex_get_size

Get size of mutex object. This API is used to get the mutex object size for client to allocate memory for the mutex object. @datatypes ar_osal_mutex_t
Returns Size of mutex object

ar_osal_mutex_create

Creates and initialize a mutex. Recursive mutex are always used. Mutex memory allocation and initialization done by this API osal_mutex_create() or osal_mutex_init() would be used, but not both. @datatypes ar_osal_mutex_t
Parameters
mutex: Pointer to the mutex object handle.
Returns 0 Success Nonzero Failure

ar_osal_mutex_destroy

Delete/free a mutex object. This function must be called for each corresponding osal_mutex_create function to clean up all resources. @datatypes ar_osal_mutex_t
Parameters
ar_osal_mutex_t
Pointer to the mutex.
Returns 0 Success Nonzero Failure

ar_osal_mutex_lock

Locks a mutex. Recursive mutex are always used. @datatypes ar_osal_mutex_t
Parameters
ar_osal_mutex_t
Pointer to the mutex.
Returns 0 Success Nonzero Failure

ar_osal_mutex_try_lock

Attempts to lock a mutex. If the mutex is already locked and unavailable, a failure is returned. @datatypes ar_osal_mutex_t
Parameters
ar_osal_mutex_t
Pointer to the mutex.
Returns 0 Success Nonzero Failure

ar_osal_mutex_unlock

Unlocks a mutex. Recursive mutex are always used. @datatypes ar_osal_mutex_t
Parameters
ar_osal_mutex_t
Pointer to the mutex.
Returns 0 Success Nonzero Failure

Type Definitions

ar_osal_mutex_t

ar osal mutex type object.