1*86f9d4cdStedu.\" $OpenBSD: pthread_cond_wait.3,v 1.10 2013/06/05 03:44:50 tedu Exp $ 282d2d131Sfgsch.\" 3a278733dSd.\" Copyright (c) 1997 Brian Cully <shmit@kublai.com> 4a278733dSd.\" All rights reserved. 5a278733dSd.\" 6a278733dSd.\" Redistribution and use in source and binary forms, with or without 7a278733dSd.\" modification, are permitted provided that the following conditions 8a278733dSd.\" are met: 9a278733dSd.\" 1. Redistributions of source code must retain the above copyright 10a278733dSd.\" notice, this list of conditions and the following disclaimer. 11a278733dSd.\" 2. Redistributions in binary form must reproduce the above copyright 12a278733dSd.\" notice, this list of conditions and the following disclaimer in the 13a278733dSd.\" documentation and/or other materials provided with the distribution. 14a278733dSd.\" 3. Neither the name of the author nor the names of any co-contributors 15a278733dSd.\" may be used to endorse or promote products derived from this software 16a278733dSd.\" without specific prior written permission. 17a278733dSd.\" 18a278733dSd.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 19a278733dSd.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20a278733dSd.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21a278733dSd.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 22a278733dSd.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23a278733dSd.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24a278733dSd.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25a278733dSd.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26a278733dSd.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27a278733dSd.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28a278733dSd.\" SUCH DAMAGE. 29a278733dSd.\" 3074493c91Sd.\" $FreeBSD: pthread_cond_wait.3,v 1.6 1999/08/28 00:03:04 peter Exp $ 3174493c91Sd.\" 32*86f9d4cdStedu.Dd $Mdocdate: June 5 2013 $ 33a278733dSd.Dt PTHREAD_COND_WAIT 3 34c043c0f7Sd.Os 35a278733dSd.Sh NAME 36a278733dSd.Nm pthread_cond_wait 37a278733dSd.Nd wait on a condition variable 38a278733dSd.Sh SYNOPSIS 39*86f9d4cdStedu.In pthread.h 40a278733dSd.Ft int 41a278733dSd.Fn pthread_cond_wait "pthread_cond_t *cond" "pthread_mutex_t *mutex" 42a278733dSd.Sh DESCRIPTION 43a278733dSdThe 44a278733dSd.Fn pthread_cond_wait 45a278733dSdfunction atomically blocks the current thread waiting on the condition 46a278733dSdvariable specified by 47a278733dSd.Fa cond , 48a278733dSdand unblocks the mutex specified by 49a278733dSd.Fa mutex . 50a278733dSdThe waiting thread unblocks only after another thread calls 51ee997aeaSmpech.Xr pthread_cond_signal 3 , 52ee997aeaSmpechor 53a278733dSd.Xr pthread_cond_broadcast 3 54379cec13Spvalchevwith the same condition variable, and the current thread reacquires the lock 55a278733dSdon 56a278733dSd.Fa mutex . 57a278733dSd.Sh RETURN VALUES 58a278733dSdIf successful, the 59a278733dSd.Fn pthread_cond_wait 60ee997aeaSmpechfunction will return zero. 61ee997aeaSmpechOtherwise an error number will be returned to indicate the error. 62a278733dSd.Sh ERRORS 63a278733dSd.Fn pthread_cond_wait 64a278733dSdwill fail if: 65a278733dSd.Bl -tag -width Er 66a278733dSd.It Bq Er EINVAL 67a278733dSdThe value specified by 68a278733dSd.Fa cond 69a278733dSdor the value specified by 7074493c91Sd.Fa mutex 71a278733dSdis invalid. 72a278733dSd.El 73a278733dSd.Sh SEE ALSO 74f8344ebdSd.Xr pthread_cond_broadcast 3 , 75a278733dSd.Xr pthread_cond_destroy 3 , 76f8344ebdSd.Xr pthread_cond_init 3 , 77a278733dSd.Xr pthread_cond_signal 3 , 78f8344ebdSd.Xr pthread_cond_timedwait 3 79a278733dSd.Sh STANDARDS 80a278733dSd.Fn pthread_cond_wait 8182d2d131Sfgschconforms to 8282d2d131Sfgsch.St -p1003.1-96 . 83