projects / apple / libpthread.git / blame
| Commit | Line | Data |
|---|---|---|
| f1a1da6c A |
1 | .\" Portions Copyright (c) 2001 Apple Computer, Inc. All Rights Reserved. |
| 2 | .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com> | |
| 3 | .\" All rights reserved. | |
| 4 | .\" | |
| 5 | .\" Redistribution and use in source and binary forms, with or without | |
| 6 | .\" modification, are permitted provided that the following conditions | |
| 7 | .\" are met: | |
| 8 | .\" 1. Redistributions of source code must retain the above copyright | |
| 9 | .\" notice, this list of conditions and the following disclaimer. | |
| 10 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
| 11 | .\" notice, this list of conditions and the following disclaimer in the | |
| 12 | .\" documentation and/or other materials provided with the distribution. | |
| 13 | .\" 3. Neither the name of the author nor the names of any co-contributors | |
| 14 | .\" may be used to endorse or promote products derived from this software | |
| 15 | .\" without specific prior written permission. | |
| 16 | .\" | |
| 17 | .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND | |
| 18 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 19 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 20 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
| 21 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
| 22 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
| 23 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 24 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
| 25 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
| 26 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
| 27 | .\" SUCH DAMAGE. | |
| 28 | .\" | |
| 2546420a | 29 | .\" $FreeBSD$ |
| f1a1da6c | 30 | .\" |
| 2546420a | 31 | .Dd February 16, 2006 |
| f1a1da6c A |
32 | .Dt PTHREAD_COND_WAIT 3 |
| 33 | .Os Darwin | |
| 34 | .Sh NAME | |
| 35 | .Nm pthread_cond_wait | |
| 36 | .Nd wait on a condition variable | |
| 37 | .Sh SYNOPSIS | |
| 2546420a | 38 | .In pthread.h |
| f1a1da6c | 39 | .Ft int |
| 2546420a | 40 | .Fn pthread_cond_wait "pthread_cond_t *cond" "pthread_mutex_t *mutex" |
| f1a1da6c A |
41 | .Sh DESCRIPTION |
| 42 | The | |
| 43 | .Fn pthread_cond_wait | |
| 2546420a A |
44 | function atomically blocks the current thread waiting on the condition |
| 45 | variable specified by | |
| 46 | .Fa cond , | |
| 47 | and releases the mutex specified by | |
| 48 | .Fa mutex . | |
| 49 | The waiting thread unblocks only after another thread calls | |
| 50 | .Xr pthread_cond_signal 3 , | |
| f1a1da6c A |
51 | or |
| 52 | .Xr pthread_cond_broadcast 3 | |
| 2546420a A |
53 | with the same condition variable, and the current thread reacquires the lock |
| 54 | on | |
| f1a1da6c A |
55 | .Fa mutex . |
| 56 | .Sh RETURN VALUES | |
| 57 | If successful, the | |
| 58 | .Fn pthread_cond_wait | |
| 2546420a A |
59 | function will return zero. |
| 60 | Otherwise an error number will be returned to | |
| f1a1da6c A |
61 | indicate the error. |
| 62 | .Sh ERRORS | |
| 2546420a | 63 | The |
| f1a1da6c | 64 | .Fn pthread_cond_wait |
| 2546420a | 65 | function will fail if: |
| f1a1da6c A |
66 | .Bl -tag -width Er |
| 67 | .It Bq Er EINVAL | |
| 68 | The value specified by | |
| 69 | .Fa cond | |
| 70 | or the value specified by | |
| 71 | .Fa mutex | |
| 72 | is invalid. | |
| 73 | .El | |
| 74 | .Sh SEE ALSO | |
| 75 | .Xr pthread_cond_broadcast 3 , | |
| 76 | .Xr pthread_cond_destroy 3 , | |
| 77 | .Xr pthread_cond_init 3 , | |
| 78 | .Xr pthread_cond_signal 3 , | |
| 79 | .Xr pthread_cond_timedwait 3 | |
| 80 | .Sh STANDARDS | |
| 2546420a | 81 | The |
| f1a1da6c | 82 | .Fn pthread_cond_wait |
| 2546420a | 83 | function conforms to |
| f1a1da6c | 84 | .St -p1003.1-96 . |