mtx_trylock

C

Language

Headers

Type support

Program utilities

Variadic function support

Error handling

Dynamic memory management

Date and time utilities

Strings library

Algorithms

Numerics

Input/output support

Localization support

Atomic operations (C11)

Thread support (C11)

Technical Specifications

Thread support library

Threads
thrd_create thrd_equal thrd_current thrd_sleep thrd_yield thrd_exit	thrd_detach thrd_join thrd_successthrd_timedoutthrd_busythrd_nomemthrd_error
Mutual exclusion
mtx_init mtx_lock mtx_timedlock mtx_trylock call_once	mtx_unlock mtx_destroy mtx_plainmtx_recursivemtx_timed
Condition variables
cnd_init cnd_signal cnd_broadcast	cnd_wait cnd_timedwait cnd_destroy
Thread-local storage
thread_local TSS_DTOR_ITERATIONS tss_create	tss_get tss_set tss_delete

Defined in header <threads.h>
int mtx_trylock( mtx_t *mutex );		(since C11)

Tries to lock the mutex pointed to by mutex without blocking. Returns immediately if the mutex is already locked.

Prior calls to mtx_unlock on the same mutex synchronize-with this operation (if this operation succeeds), and all lock/unlock operations on any given mutex form a single total order (similar to the modification order of an atomic)

Parameters

mutex

-

pointer to the mutex to lock

Return value

thrd_success if successful, thrd_busy if the mutex has already been locked or due to a spurious failure to acquire an available mutex (since C17), thrd_error if an error occurs.

References

• C11 standard (ISO/IEC 9899:2011):

• 7.26.4.5 The mtx_trylock function (p: 382)

See also

mtx_lock (C11)	blocks until locks a mutex (function)
mtx_timedlock (C11)	blocks until locks a mutex or times out (function)
mtx_unlock (C11)	unlocks a mutex (function)