projects / apple / libc.git / blame
| Commit | Line | Data |
|---|---|---|
| 5b2abdfb 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 | .\" | |
| 28 | .\" $FreeBSD: src/lib/libc_r/man/pthread_cond_timedwait.3,v 1.8.2.6 2001/08/17 15:42:51 ru Exp $ | |
| 29 | .\" | |
| 30 | .Dd July 28, 1998 | |
| 31 | .Dt PTHREAD_COND_TIMEDWAIT 3 | |
| 32 | .Os | |
| 33 | .Sh NAME | |
| 34 | .Nm pthread_cond_timedwait | |
| 35 | .Nd "wait on a condition variable for a specific amount of time" | |
| 36 | .Sh SYNOPSIS | |
| 37 | .Fd #include <pthread.h> | |
| 38 | .Ft int | |
| 224c7076 A |
39 | .Fo pthread_cond_timedwait |
| 40 | .Fa "pthread_cond_t *restrict cond" | |
| 41 | .Fa "pthread_mutex_t *restrict mutex" | |
| 42 | .Fa "const struct timespec *restrict abstime" | |
| 43 | .Fc | |
| 5b2abdfb A |
44 | .Sh DESCRIPTION |
| 45 | The | |
| 46 | .Fn pthread_cond_timedwait | |
| 47 | function atomically blocks the current thread waiting on the condition | |
| 48 | variable specified by | |
| 224c7076 | 49 | .Fa cond |
| 5b2abdfb A |
50 | and unblocks the mutex specified by |
| 51 | .Fa mutex . | |
| 52 | The waiting thread unblocks only after another thread calls | |
| 53 | .Xr pthread_cond_signal 3 , | |
| 54 | or | |
| 55 | .Xr pthread_cond_broadcast 3 | |
| 56 | with the same condition variable, or if the system time reaches the | |
| 57 | time specified in | |
| 58 | .Fa abstime , | |
| 59 | and the current thread reacquires the lock on | |
| 60 | .Fa mutex . | |
| 61 | .Sh RETURN VALUES | |
| 62 | If successful, the | |
| 63 | .Fn pthread_cond_timedwait | |
| 64 | function will return zero. | |
| 224c7076 | 65 | Otherwise, an error number will be returned to |
| 5b2abdfb A |
66 | indicate the error. |
| 67 | .Sh ERRORS | |
| 68 | .Fn pthread_cond_timedwait | |
| 69 | will fail if: | |
| 70 | .Bl -tag -width Er | |
| 71 | .It Bq Er EINVAL | |
| 72 | The value specified by | |
| 73 | .Fa cond , | |
| 74 | .Fa mutex | |
| 75 | or | |
| 76 | .Fa abstime | |
| 77 | is invalid. | |
| 78 | .It Bq Er ETIMEDOUT | |
| 79 | The system time has reached or exceeded the time specified in | |
| 80 | .Fa abstime . | |
| 81 | .El | |
| 82 | .Sh SEE ALSO | |
| 83 | .Xr pthread_cond_broadcast 3 , | |
| 84 | .Xr pthread_cond_destroy 3 , | |
| 85 | .Xr pthread_cond_init 3 , | |
| 86 | .Xr pthread_cond_signal 3 , | |
| 87 | .Xr pthread_cond_wait 3 | |
| 88 | .Sh STANDARDS | |
| 89 | .Fn pthread_cond_timedwait | |
| 90 | conforms to | |
| 91 | .St -p1003.1-96 . |