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 February 3, 2018 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.In pthread_np.h 47.Ft int 48.Fn pthread_timedjoin_np "pthread_t thread" "void **value_ptr" "const struct timespec *abstime" 49.Sh DESCRIPTION 50The 51.Fn pthread_join 52function suspends execution of the calling thread until the target 53.Fa thread 54terminates unless the target 55.Fa thread 56has already terminated. 57.Pp 58On return from a successful 59.Fn pthread_join 60call with a non-NULL 61.Fa value_ptr 62argument, the value passed to 63.Fn pthread_exit 64by the terminating thread is stored in the location referenced by 65.Fa value_ptr . 66When a 67.Fn pthread_join 68returns successfully, the target thread has been terminated. 69The results 70of multiple simultaneous calls to 71.Fn pthread_join 72specifying the same target thread are undefined. 73If the thread calling 74.Fn pthread_join 75is cancelled, then the target thread is not detached. 76.Pp 77The 78.Fn pthread_timedjoin_np 79function is equivalent to the 80.Fn pthread_join 81function except it will return 82.Er ETIMEDOUT 83if target thread does not exit before specified absolute time passes. 84.Pp 85A thread that has exited but remains unjoined counts against 86[_POSIX_THREAD_THREADS_MAX]. 87.Sh RETURN VALUES 88If successful, the 89.Fn pthread_join 90and 91.Fn pthread_timedjoin_np 92functions will return zero. 93Otherwise an error number will be returned to 94indicate the error. 95.Sh ERRORS 96The 97.Fn pthread_join 98and 99.Fn pthread_timedjoin_np 100functions will fail if: 101.Bl -tag -width Er 102.It Bq Er EINVAL 103The implementation has detected that the value specified by 104.Fa thread 105does not refer to a joinable thread. 106.It Bq Er ESRCH 107No thread could be found corresponding to that specified by the given 108thread ID, 109.Fa thread . 110.It Bq Er EDEADLK 111A deadlock was detected or the value of 112.Fa thread 113specifies the calling thread. 114.It Bq Er EOPNOTSUPP 115The implementation detected that another caller is already waiting on 116.Fa thread . 117.El 118.Pp 119Additionally, the 120.Fn pthread_timedjoin_np 121function will fail if: 122.Bl -tag -width Er 123.It Bq Er ETIMEDOUT 124The specified absolute time passed while 125.Fn pthread_timedjoin_np 126waited for thread exit. 127.El 128.Sh SEE ALSO 129.Xr wait 2 , 130.Xr pthread_create 3 131.Sh STANDARDS 132The 133.Fn pthread_join 134function conforms to 135.St -p1003.1-96 . 136The 137.Fn pthread_timedjoin_np 138function is a 139.Fx 140extension which was added to 141.Dx 1.3 . 142