]>
Commit | Line | Data |
---|---|---|
f1a1da6c A |
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: src/lib/libc_r/man/pthread_cond_timedwait.3,v 1.8.2.6 2001/08/17 15:42:51 ru Exp $ | |
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 SYNOPSIS | |
37 | .Fd #include <pthread.h> | |
38 | .Ft int | |
39 | .Fo pthread_cond_timedwait | |
40 | .Fa "pthread_cond_t *restrict cond" | |
41 | .Fa "pthread_mutex_t *restrict mutex" | |
42 | .Fa "const struct timespec *restrict abstime" | |
43 | .Fc | |
44 | .Sh DESCRIPTION | |
45 | The | |
46 | .Fn pthread_cond_timedwait | |
47 | function atomically blocks the current thread waiting on the condition | |
48 | variable specified by | |
49 | .Fa cond | |
50 | and unblocks the mutex specified by | |
51 | .Fa mutex . | |
52 | The waiting thread unblocks only after another thread calls | |
53 | .Xr pthread_cond_signal 3 , | |
54 | or | |
55 | .Xr pthread_cond_broadcast 3 | |
56 | with the same condition variable, or if the system time reaches the | |
57 | time specified in | |
58 | .Fa abstime , | |
59 | and the current thread reacquires the lock on | |
60 | .Fa mutex . | |
61 | .Pp | |
62 | Values for struct timespec can be obtained by adding the required | |
63 | time interval to the the current time obtained using | |
64 | .Xr gettimeofday 2 . | |
65 | .Pp | |
66 | .Fa Note | |
67 | that struct timeval and struct timespec use different units to specify | |
68 | the time. Hence, the user should always take care to perform the time unit | |
69 | conversions accordingly. | |
70 | .Sh EXAMPLE | |
71 | .Pp | |
72 | struct timeval tv; | |
73 | struct timespec ts; | |
74 | gettimeofday(&tv, NULL); | |
75 | ts.tv_sec = tv.tv_sec + 0; | |
76 | ts.tv_nsec = 0; | |
77 | .Pp | |
78 | .Sh RETURN VALUES | |
79 | If successful, the | |
80 | .Fn pthread_cond_timedwait | |
81 | function will return zero. | |
82 | Otherwise, an error number will be returned to | |
83 | indicate the error. | |
84 | .Sh ERRORS | |
85 | .Fn pthread_cond_timedwait | |
86 | will fail if: | |
87 | .Bl -tag -width Er | |
88 | .It Bq Er EINVAL | |
89 | The value specified by | |
90 | .Fa cond , | |
91 | .Fa mutex | |
92 | or | |
93 | .Fa abstime | |
94 | is invalid. | |
95 | .It Bq Er ETIMEDOUT | |
96 | The system time has reached or exceeded the time specified in | |
97 | .Fa abstime . | |
98 | .El | |
99 | .Sh SEE ALSO | |
100 | .Xr pthread_cond_broadcast 3 , | |
101 | .Xr pthread_cond_destroy 3 , | |
102 | .Xr pthread_cond_init 3 , | |
103 | .Xr pthread_cond_signal 3 , | |
104 | .Xr pthread_cond_wait 3 , | |
105 | .Xr gettimeofday 2 | |
106 | .Sh STANDARDS | |
107 | .Fn pthread_cond_timedwait | |
108 | conforms to | |
109 | .St -p1003.1-96 . |