pthread_mutex_trylock(3-thr) pthread_mutex_trylock(3-thr)
NAME
pthreadmutextrylock - locks a mutex
SYNOPSIS
#include <pthread.h>
int pthreadmutextrylock(pthreadmutext *mutex);
PARAMETERS
mutex Mutex that is locked.
DESCRIPTION
The pthreadmutextrylock() routine locks a mutex. If the specified
mutex is locked when a thread calls this routine, the calling thread
does not wait for the mutex to become available.
When a thread calls this routine, an attempt is made to lock the mutex
immediately. If the mutex is successfully locked, 1 is returned and
the current thread is then the mutex's current owner.
If the mutex is locked by another thread when this routine is called,
0 (zero) is returned and the thread does not wait to acquire the lock.
If a fast mutex is owned by the current thread, 0 is returned. If a
recursive mutex is owned by the current thread, 1 is returned and the
mutex is relocked. (To unlock a recursive mutex, each call to
pthreadmutextrylock() must be matched by a call to the
pthreadmutexunlock() routine.)
RETURN VALUES
If the function fails, errno may be set to one of the following
values:
EINVAL The value specified by mutex is invalid.
SEE ALSO
pthreadmutexdestroy(3-thr), pthreadmutexinit(3-thr),
pthreadmutexlock(3-thr), pthreadmutexunlock(3-thr),
pthreadmutexattrsetkindnp(3-thr).
Page 1 Reliant UNIX 5.44 Printed 11/98