monoZ docs
Mutex

-For mutex related APIs refer MZ_sys_cmsis_os2.h file. More...

Functions

uint8_t mz_mutex_create (mz_mutex_t *c)
 This function is used to create and initialize the mutex object Create and Initialize a Mutex object. More...
 
uint8_t mz_mutex_lock (mz_mutex_t *c)
 This function is used to acquire the mutex or timeout if it is locked Acquire a Mutex or timeout if it is locked. More...
 
uint8_t mz_mutex_unlock (mz_mutex_t *c)
 This function is used to release the mutex Release a Mutex that was acquired by. More...
 
uint8_t mz_mutex_delete (mz_mutex_t *c)
 This function is used to delete the mutex object Delete a Mutex object. More...
 
uint8_t mz_mutex_isvalid (mz_mutex_t *c)
 This function is used to check the mutex object validity Check the Mutex Object Validation. More...
 
uint8_t mz_mutex_invalid (mz_mutex_t *c)
 This function is used to invalidate the created mutex object Mutex Object created is invalid. More...
 

Detailed Description

-For mutex related APIs refer MZ_sys_cmsis_os2.h file.

Function Documentation

◆ mz_mutex_create()

uint8_t mz_mutex_create ( mz_mutex_t c)

This function is used to create and initialize the mutex object Create and Initialize a Mutex object.

Parameters
cmz_mutex_t
Returns
mutex ID for reference by other functions or NULL in case of error.

◆ mz_mutex_lock()

uint8_t mz_mutex_lock ( mz_mutex_t c)

This function is used to acquire the mutex or timeout if it is locked Acquire a Mutex or timeout if it is locked.

Parameters
cmz_mutex_t
Returns
status code that indicates the execution status of the function.

◆ mz_mutex_unlock()

uint8_t mz_mutex_unlock ( mz_mutex_t c)

This function is used to release the mutex Release a Mutex that was acquired by.

Parameters
cmz_mutex_t
Returns
status code that indicates the execution status of the function.

◆ mz_mutex_delete()

uint8_t mz_mutex_delete ( mz_mutex_t c)

This function is used to delete the mutex object Delete a Mutex object.

Parameters
cmz_mutex_t
Returns
status code that indicates the execution status of the function.

◆ mz_mutex_isvalid()

uint8_t mz_mutex_isvalid ( mz_mutex_t c)

This function is used to check the mutex object validity Check the Mutex Object Validation.

Parameters
cmz_mutex_t
Returns
status code that indicates the execution status of the function.

◆ mz_mutex_invalid()

uint8_t mz_mutex_invalid ( mz_mutex_t c)

This function is used to invalidate the created mutex object Mutex Object created is invalid.

Parameters
cmz_mutex_t
Returns
1