1 .\" Copyright (c) 1996-1998 John Birrell <jb@cimlogic.com.au>.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by John Birrell.
15 .\" 4. Neither the name of the author nor the names of any co-contributors
16 .\" may be used to endorse or promote products derived from this software
17 .\" without specific prior written permission.
19 .\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND
20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 .Nm pthread_timedjoin_np
39 .Nd wait for thread termination
45 .Fn pthread_join "pthread_t thread" "void **value_ptr"
48 .Fn pthread_timedjoin_np "pthread_t thread" "void **value_ptr" "const struct timespec *abstime"
52 function suspends execution of the calling thread until the target
54 terminates unless the target
56 has already terminated.
58 On return from a successful
62 argument, the value passed to
64 by the terminating thread is stored in the location referenced by
68 returns successfully, the target thread has been terminated.
70 of multiple simultaneous calls to
72 specifying the same target thread are undefined.
75 is cancelled, then the target thread is not detached.
78 .Fn pthread_timedjoin_np
79 function is equivalent to the
81 function except it will return
83 if target thread does not exit before specified absolute time passes.
85 A thread that has exited but remains unjoined counts against
86 [_POSIX_THREAD_THREADS_MAX].
91 .Fn pthread_timedjoin_np
92 functions will return zero.
93 Otherwise an error number will be returned to
99 .Fn pthread_timedjoin_np
100 functions will fail if:
103 The implementation has detected that the value specified by
105 does not refer to a joinable thread.
107 No thread could be found corresponding to that specified by the given
111 A deadlock was detected or the value of
113 specifies the calling thread.
115 The implementation detected that another caller is already waiting on
120 .Fn pthread_timedjoin_np
121 function will fail if:
124 The specified absolute time passed while
125 .Fn pthread_timedjoin_np
126 waited for thread exit.
137 .Fn pthread_timedjoin_np
140 extension which first appeared in