Move pthread* manpages to lib/libpthread as they are not libc_r specific.
[dragonfly.git] / lib / libpthread / pthread_mutex_trylock.3
CommitLineData
984263bc
MD
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.\" $FreeBSD: src/lib/libc_r/man/pthread_mutex_trylock.3,v 1.5.2.5 2001/12/17 10:08:26 ru Exp $
1de703da 29.\" $DragonFly: src/lib/libc_r/man/pthread_mutex_trylock.3,v 1.2 2003/06/17 04:26:48 dillon Exp $
984263bc
MD
30.\"
31.Dd July 30, 1998
32.Dt PTHREAD_MUTEX_TRYLOCK 3
33.Os
34.Sh NAME
35.Nm pthread_mutex_trylock
36.Nd attempt to lock a mutex without blocking
37.Sh LIBRARY
38.Lb libc_r
39.Sh SYNOPSIS
40.In pthread.h
41.Ft int
42.Fn pthread_mutex_trylock "pthread_mutex_t *mutex"
43.Sh DESCRIPTION
44The
45.Fn pthread_mutex_trylock
46function locks
47.Fa mutex .
48If the mutex is already locked,
49.Fn pthread_mutex_trylock
50will not block waiting for the mutex, but will return an error condition.
51.Sh RETURN VALUES
52If successful,
53.Fn pthread_mutex_trylock
54will return zero, otherwise an error number will be returned to
55indicate the error.
56.Sh ERRORS
57.Fn pthread_mutex_trylock
58will fail if:
59.Bl -tag -width Er
60.It Bq Er EINVAL
61The value specified by
62.Fa mutex
63is invalid.
64.It Bq Er EBUSY
65.Fa Mutex
66is already locked.
67.El
68.Sh SEE ALSO
69.Xr pthread_mutex_destroy 3 ,
70.Xr pthread_mutex_init 3 ,
71.Xr pthread_mutex_lock 3 ,
72.Xr pthread_mutex_unlock 3
73.Sh STANDARDS
74.Fn pthread_mutex_trylock
75conforms to
76.St -p1003.1-96 .