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.Dd May 9, 2010
29.Dt PTHREAD_COND_TIMEDWAIT 3
30.Os
31.Sh NAME
32.Nm pthread_cond_timedwait
33.Nd "wait on a condition variable for a specific amount of time"
34.Sh LIBRARY
35.Lb libpthread
36.Sh SYNOPSIS
37.In pthread.h
38.Ft int
39.Fn pthread_cond_timedwait "pthread_cond_t *cond" "pthread_mutex_t *mutex" "const struct timespec *abstime"
40.Sh DESCRIPTION
41The
42.Fn pthread_cond_timedwait
43function atomically blocks the current thread waiting on the condition
44variable specified by
45.Fa cond ,
46and releases the mutex specified by
47.Fa mutex .
48The waiting thread unblocks only after another thread calls
49.Xr pthread_cond_signal 3 ,
50or
51.Xr pthread_cond_broadcast 3
52with the same condition variable, or if the system time reaches the
53time specified in
54.Fa abstime ,
55and the current thread reacquires the lock on
56.Fa mutex .
57.Pp
58The clock used to measure
59.Fa abstime
60can be specified during creation of the condition variable using
61.Xr pthread_condattr_setclock 3 .
62.Sh RETURN VALUES
63If successful, the
64.Fn pthread_cond_timedwait
65function will return zero.
66Otherwise an error number will be returned to
67indicate the error.
68.Sh ERRORS
69The
70.Fn pthread_cond_timedwait
71function will fail if:
72.Bl -tag -width Er
73.It Bq Er EINVAL
74The value specified by
75.Fa cond ,
76.Fa mutex
77or
78.Fa abstime
79is invalid.
80.It Bq Er ETIMEDOUT
81The system time has reached or exceeded the time specified in
82.Fa abstime .
83.It Bq Er EPERM
84The specified
85.Fa mutex
86was not locked by the calling thread.
87.El
88.Sh SEE ALSO
89.Xr pthread_cond_broadcast 3 ,
90.Xr pthread_cond_destroy 3 ,
91.Xr pthread_cond_init 3 ,
92.Xr pthread_cond_signal 3 ,
93.Xr pthread_cond_wait 3 ,
94.Xr pthread_condattr_setclock 3
95.Sh STANDARDS
96The
97.Fn pthread_cond_timedwait
98function conforms to
99.St -p1003.1-96 .
100