1.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com> 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 3. Neither the name of the author nor the names of any co-contributors 13.\" may be used to endorse or promote products derived from this software 14.\" without specific prior written permission. 15.\" 16.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26.\" SUCH DAMAGE. 27.\" 28.Dd July 30, 1998 29.Dt PTHREAD_MUTEX_TRYLOCK 3 30.Os BSD 4 31.Sh NAME 32.Nm pthread_mutex_trylock 33.Nd attempt to lock a mutex without blocking 34.Sh SYNOPSIS 35.Fd #include <pthread.h> 36.Ft int 37.Fn pthread_mutex_trylock "pthread_mutex_t *mutex" 38.Sh DESCRIPTION 39The 40.Fn pthread_mutex_trylock 41function locks 42.Fa mutex . 43If the mutex is already locked, 44.Fn pthread_mutex_trylock 45will not block waiting for the mutex, but will return an error condition. 46.Sh RETURN VALUES 47If successful, 48.Fn pthread_mutex_trylock 49will return zero, otherwise an error number will be returned to 50indicate the error. 51.Sh ERRORS 52.Fn pthread_mutex_trylock 53will fail if: 54.Bl -tag -width Er 55.It Bq Er EINVAL 56The value specified by 57.Fa mutex 58is invalid. 59.It Bq Er EBUSY 60.Fa Mutex 61is already locked. 62.El 63.Pp 64.Sh SEE ALSO 65.Xr pthread_mutex_destroy 3 , 66.Xr pthread_mutex_init 3 , 67.Xr pthread_mutex_lock 3 , 68.Xr pthread_mutex_unlock 3 69.Sh STANDARDS 70.Fn pthread_mutex_trylock 71conforms to ISO/IEC 9945-1 ANSI/IEEE 72.Pq Dq Tn POSIX 73Std 1003.1 Second Edition 1996-07-12. 74