1 .\" Copyright (c) 1997 Brian Cully <shmit@kublai.com>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
31 .Dt PTHREAD_COND_WAIT 3
35 .Nd wait on a condition variable
41 .Fn pthread_cond_wait "pthread_cond_t *restrict cond" "pthread_mutex_t *restrict mutex"
45 function atomically blocks the current thread waiting on the condition
48 and releases the mutex specified by
50 The waiting thread unblocks only after another thread calls
51 .Xr pthread_cond_signal 3 ,
53 .Xr pthread_cond_broadcast 3
54 with the same condition variable, and the current thread reacquires the lock
60 function will return zero.
61 Otherwise an error number will be returned to
66 function will fail if:
69 The value specified by
71 or the value specified by
77 was not locked by the calling thread.
81 points to a robust mutex and the process containing the previous owning
82 thread terminated while holding the mutex lock.
83 The lock was granted to the caller and it is up to the new owner
84 to make the state consistent.
85 .It Bq Er ENOTRECOVERABLE
86 The state protected by the
91 .Xr pthread_cond_broadcast 3 ,
92 .Xr pthread_cond_destroy 3 ,
93 .Xr pthread_cond_init 3 ,
94 .Xr pthread_cond_signal 3 ,
95 .Xr pthread_cond_timedwait 3 ,
96 .Xr pthread_mutex_consistent 3