1.\" $OpenBSD: pthread_cond_timedwait.3,v 1.6 2000/02/10 11:46:24 d Exp $ 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.\" 29.\" $FreeBSD: pthread_cond_timedwait.3,v 1.6 1999/08/28 00:03:04 peter Exp $ 30.\" 31.Dd July 28, 1998 32.Dt PTHREAD_COND_TIMEDWAIT 3 33.Os 34.Sh NAME 35.Nm pthread_cond_timedwait 36.Nd "wait on a condition variable for a specific amount of time" 37.Sh SYNOPSIS 38.Fd #include <pthread.h> 39.Ft int 40.Fn pthread_cond_timedwait "pthread_cond_t *cond" "pthread_mutex_t *mutex" "const struct timespec *abstime" 41.Sh DESCRIPTION 42The 43.Fn pthread_cond_timedwait 44function atomically blocks the current thread waiting on the condition 45variable specified by 46.Fa cond , 47and unblocks the mutex specified by 48.Fa mutex . 49The waiting thread unblocks only after another thread calls 50.Xr pthread_cond_signal 3 , 51or 52.Xr pthread_cond_broadcast 3 53with the same condition variable, or if the system time reaches the 54time specified in 55.Fa abstime , 56and the current thread reaquires the lock on 57.Fa mutex . 58.Sh RETURN VALUES 59If successful, the 60.Fn pthread_cond_timedwait 61function will return zero. Otherwise an error number will be returned to 62indicate the error. 63.Sh ERRORS 64.Fn pthread_cond_timedwait 65will fail if: 66.Bl -tag -width Er 67.It Bq Er EINVAL 68The value specified by 69.Fa cond , 70.Fa mutex 71or 72.Fa abstime 73is invalid. 74.It Bq Er ETIMEDOUT 75The system time has reached or exceeded the time specified in 76.Fa abstime . 77.El 78.Sh SEE ALSO 79.Xr pthread_cond_broadcast 3 , 80.Xr pthread_cond_destroy 3 , 81.Xr pthread_cond_init 3 , 82.Xr pthread_cond_signal 3 , 83.Xr pthread_cond_wait 3 84.Sh STANDARDS 85.Fn pthread_cond_timedwait 86conforms to ISO/IEC 9945-1 ANSI/IEEE 87.Pq Dq Tn POSIX 88Std 1003.1 Second Edition 1996-07-12. 89