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$ 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 LIBRARY 37.Lb libc_r 38.Lb libpthread 39.Lb libthr 40.Sh SYNOPSIS 41.In pthread.h 42.Ft int 43.Fn pthread_cond_timedwait "pthread_cond_t *cond" "pthread_mutex_t *mutex" "const struct timespec *abstime" 44.Sh DESCRIPTION 45The 46.Fn pthread_cond_timedwait 47function atomically blocks the current thread waiting on the condition 48variable specified by 49.Fa cond , 50and unblocks the mutex specified by 51.Fa mutex . 52The waiting thread unblocks only after another thread calls 53.Xr pthread_cond_signal 3 , 54or 55.Xr pthread_cond_broadcast 3 56with the same condition variable, or if the system time reaches the 57time specified in 58.Fa abstime , 59and the current thread reacquires the lock on 60.Fa mutex . 61.Sh RETURN VALUES 62If successful, the 63.Fn pthread_cond_timedwait 64function will return zero. 65Otherwise an error number will be returned to 66indicate the error. 67.Sh ERRORS 68The 69.Fn pthread_cond_timedwait 70function will fail if: 71.Bl -tag -width Er 72.It Bq Er EINVAL 73The value specified by 74.Fa cond , 75.Fa mutex 76or 77.Fa abstime 78is invalid. 79.It Bq Er ETIMEDOUT 80The system time has reached or exceeded the time specified in 81.Fa abstime . 82.El 83.Sh SEE ALSO 84.Xr pthread_cond_broadcast 3 , 85.Xr pthread_cond_destroy 3 , 86.Xr pthread_cond_init 3 , 87.Xr pthread_cond_signal 3 , 88.Xr pthread_cond_wait 3 89.Sh STANDARDS 90The 91.Fn pthread_cond_timedwait 92function conforms to 93.St -p1003.1-96 . 94