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.
--- 11 unchanged lines hidden (view full) ---
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: head/share/man/man3/pthread_cond_timedwait.3 84306 2001-10-01 16:09:29Z ru $
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
--- 21 unchanged lines hidden (view full) ---
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
66.Fn pthread_cond_timedwait
67will fail if:
68.Bl -tag -width Er
69.It Bq Er EINVAL
70The value specified by
71.Fa cond ,
72.Fa mutex
73or
74.Fa abstime
75is invalid.
76.It Bq Er ETIMEDOUT
77The system time has reached or exceeded the time specified in
78.Fa abstime .
79.El
80.Sh SEE ALSO
81.Xr pthread_cond_broadcast 3 ,
82.Xr pthread_cond_destroy 3 ,
83.Xr pthread_cond_init 3 ,
84.Xr pthread_cond_signal 3 ,
85.Xr pthread_cond_wait 3
86.Sh STANDARDS
87.Fn pthread_cond_timedwait
88conforms to
89.St -p1003.1-96 .
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.
--- 11 unchanged lines hidden (view full) ---
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: head/share/man/man3/pthread_cond_timedwait.3 84306 2001-10-01 16:09:29Z ru $
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
--- 21 unchanged lines hidden (view full) ---
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
66.Fn pthread_cond_timedwait
67will fail if:
68.Bl -tag -width Er
69.It Bq Er EINVAL
70The value specified by
71.Fa cond ,
72.Fa mutex
73or
74.Fa abstime
75is invalid.
76.It Bq Er ETIMEDOUT
77The system time has reached or exceeded the time specified in
78.Fa abstime .
79.El
80.Sh SEE ALSO
81.Xr pthread_cond_broadcast 3 ,
82.Xr pthread_cond_destroy 3 ,
83.Xr pthread_cond_init 3 ,
84.Xr pthread_cond_signal 3 ,
85.Xr pthread_cond_wait 3
86.Sh STANDARDS
87.Fn pthread_cond_timedwait
88conforms to
89.St -p1003.1-96 .