mtx_lock

 

C

Language

headers

Type support

Dynamic memory management

Error handling

Program utilities

Variadic function support

Date and time utilities

Strings library

Algorithms

Numerics

Input/output support

Localization support

Thread support (C11)

Atomic operations (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_lock( mtx_t* mutex );		(since C11)

Blocks the current thread until the mutex pointed to by mutex is locked.

The behavior is undefined if the current thread has already locked the mutex and the mutex is not recursive.

Prior calls to mtx_unlock on the same mutex synchronize-with this operation, 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_error otherwise.

References

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

• 7.26.4.3 The mtx_lock function (p: 381)

See also

mtx_timedlock (C11)	blocks until locks a mutex or times out (function)
mtx_trylock (C11)	locks a mutex or returns without blocking if already locked (function)
mtx_unlock (C11)	unlocks a mutex (function)