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