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
36 .Nm pthread_peekjoin_np ,
37 .Nm pthread_timedjoin_np
38 .Nd inspect thread termination state
44 .Fn pthread_join "pthread_t thread" "void **value_ptr"
47 .Fo pthread_peekjoin_np
48 .Fa "pthread_t thread"
49 .Fa "void **value_ptr"
52 .Fo pthread_timedjoin_np
53 .Fa "pthread_t thread"
54 .Fa "void **value_ptr"
55 .Fa "const struct timespec *abstime"
60 function suspends execution of the calling thread until the target
62 terminates unless the target
64 has already terminated.
66 On return from a successful
70 argument, the value passed to
72 by the terminating thread is stored in the location referenced by
76 returns successfully, the target thread has been terminated.
78 of multiple simultaneous calls to
80 specifying the same target thread are undefined.
83 is cancelled, then the target thread is not detached.
86 .Fn pthread_timedjoin_np
87 function is equivalent to the
89 function except it will return
91 if target thread does not exit before specified absolute time passes.
94 .Fn pthread_peekjoin_np
95 only peeks into the exit status of the specified thread.
96 If the thread has not exited, the
99 Otherwise, zero is returned and the thread exit value is optionally stored
102 The target thread is left unjoined and can be used as an argument for
105 family of functions again.
107 A thread that has exited but remains unjoined counts against
108 [_POSIX_THREAD_THREADS_MAX].
110 If successful, the described functions return zero.
111 Otherwise an error number is returned to indicate the error or
116 .Fn pthread_peekjoin_np ,
118 .Fn pthread_timedjoin_np
119 functions will fail if:
122 The implementation has detected that the value specified by
124 does not refer to a joinable thread.
126 No thread could be found corresponding to that specified by the given
130 A deadlock was detected or the value of
132 specifies the calling thread.
134 The implementation detected that another caller is already waiting on
139 .Fn pthread_timedjoin_np
140 function will fail if:
143 The specified absolute time passed while
144 .Fn pthread_timedjoin_np
145 waited for thread exit.
149 .Fn pthread_peekjoin_np
150 function will also fail if:
153 The specified thread has not yet exited.
158 .Xr pthread_create 3 ,
166 .Fn pthread_timedjoin_np
169 extension which first appeared in
171 Another extension, the
172 .Fn pthread_peekjoin_np
173 function, first appearead in