Mutex used for protecting resources. More...

Detailed Description

Mutex used for protecting resources.

This module provides a mutex that can be used to ensure only one context may enter a critical section holding the lock.

Typedef Documentation

Mutex data type.

All fields in this struct are internal, and should never be modified outside of the nrf_mtx_* functions.

__STATIC_INLINE void nrf_mtx_destroy ( nrf_mtx_t * p_mtx )

Destroy mutex.

This function can be used in abort scenarios or when the mutex is no longer to be used.

Parameters

[in] p_mtx The mutex to be destroy.

__STATIC_INLINE void nrf_mtx_init ( nrf_mtx_t * p_mtx )

Initialize mutex.

This function must be called before nrf_mtx_trylock() and nrf_mtx_unlock() functions.

Parameters

[in,out] p_mtx The mutex to be initialized.

__STATIC_INLINE bool nrf_mtx_trylock ( nrf_mtx_t * p_mtx )

Try to lock a mutex.

If the mutex is already held by another context, this function will return immediately.

Parameters

[in,out] p_mtx The mutex to be locked.

__STATIC_INLINE void nrf_mtx_unlock ( nrf_mtx_t * p_mtx )

Unlock a mutex.

This function must only be called when holding the lock. Unlocking a mutex which you do not hold will give undefined behavior.

Note: Unlock must happen from the same context as the one used to lock the mutex.

Parameters

[in,out] p_mtx The mutex to be unlocked.