Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
PTHREAD_MUTEX_TRYLOCK(3) BSD Library Functions Manual PTHREAD_MUTEX_TRYLOCK(3)

NAME
     pthread_mutex_trylock -- attempt to lock a	mutex without blocking

LIBRARY
     POSIX Threads Library (libpthread,	-lpthread)

SYNOPSIS
     #include <pthread.h>

     int
     pthread_mutex_trylock(pthread_mutex_t *mutex);

DESCRIPTION
     The pthread_mutex_trylock() function locks	mutex.	If the mutex is	al-
     ready locked, pthread_mutex_trylock() will	not block waiting for the mu-
     tex, but will return an error condition.

RETURN VALUES
     If	successful, pthread_mutex_trylock() will return	zero, otherwise	an er-
     ror number	will be	returned to indicate the error.

ERRORS
     The pthread_mutex_trylock() function will fail if:

     [EINVAL]		 The value specified by	mutex is invalid.

     [EBUSY]		 Mutex is already locked.

     [EOWNERDEAD]	 The argument mutex points to a	robust mutex and the
			 previous owning thread	terminated while holding the
			 mutex lock.  The lock was granted to the caller and
			 it is up to the new owner to make the state consis-
			 tent.

     [ENOTRECOVERABLE]	 The state protected by	the mutex is not recoverable.

SEE ALSO
     pthread_mutex_consistent(3), pthread_mutex_destroy(3),
     pthread_mutex_init(3), pthread_mutex_lock(3), pthread_mutex_unlock(3)

STANDARDS
     The pthread_mutex_trylock() function conforms to ISO/IEC 9945-1:1996
     ("POSIX.1").

BSD				April 29, 2016				   BSD

NAME | LIBRARY | SYNOPSIS | DESCRIPTION | RETURN VALUES | ERRORS | SEE ALSO | STANDARDS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=pthread_mutex_trylock&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help