projects / apple / libpthread.git / blame
| Commit | Line | Data |
|---|---|---|
| f1a1da6c A |
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 | .\" | |
| 2546420a | 28 | .\" $FreeBSD$ |
| f1a1da6c A |
29 | .\" |
| 30 | .Dd July 30, 1998 | |
| 31 | .Dt PTHREAD_MUTEX_TRYLOCK 3 | |
| 32 | .Os | |
| 33 | .Sh NAME | |
| 34 | .Nm pthread_mutex_trylock | |
| 35 | .Nd attempt to lock a mutex without blocking | |
| 36 | .Sh SYNOPSIS | |
| 2546420a | 37 | .In pthread.h |
| f1a1da6c | 38 | .Ft int |
| 2546420a | 39 | .Fn pthread_mutex_trylock "pthread_mutex_t *mutex" |
| f1a1da6c A |
40 | .Sh DESCRIPTION |
| 41 | The | |
| 42 | .Fn pthread_mutex_trylock | |
| 43 | function locks | |
| 44 | .Fa mutex . | |
| 45 | If the mutex is already locked, | |
| 46 | .Fn pthread_mutex_trylock | |
| 47 | will not block waiting for the mutex, but will return an error condition. | |
| 48 | .Sh RETURN VALUES | |
| 49 | If successful, | |
| 50 | .Fn pthread_mutex_trylock | |
| 2546420a A |
51 | will return zero, otherwise an error number will be returned to |
| 52 | indicate the error. | |
| f1a1da6c | 53 | .Sh ERRORS |
| 2546420a | 54 | The |
| f1a1da6c | 55 | .Fn pthread_mutex_trylock |
| 2546420a | 56 | function will fail if: |
| f1a1da6c | 57 | .Bl -tag -width Er |
| f1a1da6c A |
58 | .It Bq Er EINVAL |
| 59 | The value specified by | |
| 60 | .Fa mutex | |
| 61 | is invalid. | |
| 2546420a A |
62 | .It Bq Er EBUSY |
| 63 | .Fa Mutex | |
| 64 | is already locked. | |
| f1a1da6c A |
65 | .El |
| 66 | .Sh SEE ALSO | |
| 67 | .Xr pthread_mutex_destroy 3 , | |
| 68 | .Xr pthread_mutex_init 3 , | |
| 69 | .Xr pthread_mutex_lock 3 , | |
| 70 | .Xr pthread_mutex_unlock 3 | |
| 71 | .Sh STANDARDS | |
| 2546420a | 72 | The |
| f1a1da6c | 73 | .Fn pthread_mutex_trylock |
| 2546420a | 74 | function conforms to |
| f1a1da6c | 75 | .St -p1003.1-96 . |