1.\" Copyright (c) 1996-1998 John Birrell <jb@cimlogic.com.au>. 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. 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. 18.\" 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 29.\" SUCH DAMAGE. 30.\" 31.\" $FreeBSD: head/share/man/man3/pthread_join.3 209588 2010-06-29 14:32:01Z jhb $ 32.\" 33.Dd December 12, 2017 34.Dt PTHREAD_JOIN 3 35.Os 36.Sh NAME 37.Nm pthread_join , 38.Nm pthread_timedjoin_np 39.Nd wait for thread termination 40.Sh LIBRARY 41.Lb libpthread 42.Sh SYNOPSIS 43.In pthread.h 44.Ft int 45.Fn pthread_join "pthread_t thread" "void **value_ptr" 46.Ft int 47.Fn pthread_timedjoin_np "pthread_t thread" "void **value_ptr" "const struct timespec *abstime" 48.Sh DESCRIPTION 49The 50.Fn pthread_join 51function suspends execution of the calling thread until the target 52.Fa thread 53terminates unless the target 54.Fa thread 55has already terminated. 56.Pp 57On return from a successful 58.Fn pthread_join 59call with a non-NULL 60.Fa value_ptr 61argument, the value passed to 62.Fn pthread_exit 63by the terminating thread is stored in the location referenced by 64.Fa value_ptr . 65When a 66.Fn pthread_join 67returns successfully, the target thread has been terminated. 68The results 69of multiple simultaneous calls to 70.Fn pthread_join 71specifying the same target thread are undefined. 72If the thread calling 73.Fn pthread_join 74is cancelled, then the target thread is not detached. 75.Pp 76The 77.Fn pthread_timedjoin_np 78function is equivalent to the 79.Fn pthread_join 80function except it will return 81.Er ETIMEDOUT 82if target thread does not exit before specified absolute time passes. 83.Pp 84A thread that has exited but remains unjoined counts against 85[_POSIX_THREAD_THREADS_MAX]. 86.Sh RETURN VALUES 87If successful, the 88.Fn pthread_join 89and 90.Fn pthread_timedjoin_np 91functions will return zero. 92Otherwise an error number will be returned to 93indicate the error. 94.Sh ERRORS 95The 96.Fn pthread_join 97and 98.Fn pthread_timedjoin_np 99functions will fail if: 100.Bl -tag -width Er 101.It Bq Er EINVAL 102The implementation has detected that the value specified by 103.Fa thread 104does not refer to a joinable thread. 105.It Bq Er ESRCH 106No thread could be found corresponding to that specified by the given 107thread ID, 108.Fa thread . 109.It Bq Er EDEADLK 110A deadlock was detected or the value of 111.Fa thread 112specifies the calling thread. 113.It Bq Er EOPNOTSUPP 114The implementation detected that another caller is already waiting on 115.Fa thread . 116.El 117.Pp 118Additionally, the 119.Fn pthread_timedjoin_np 120function will fail if: 121.Bl -tag -width Er 122.It Bq Er ETIMEDOUT 123The specified absolute time passed while 124.Fn pthread_timedjoin_np 125waited for thread exit. 126.El 127.Sh SEE ALSO 128.Xr wait 2 , 129.Xr pthread_create 3 130.Sh STANDARDS 131The 132.Fn pthread_join 133function conforms to 134.St -p1003.1-96 . 135The 136.Fn pthread_timedjoin_np 137function is a 138.Fx 139extension which was added to 140.Dx 1.3 . 141