1.\" Copyright (c) 1996 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.Dd April 4, 1996 32.Dt PTHREAD_JOIN 3 33.Os BSD 4 34.Sh NAME 35.Nm pthread_join 36.Nd wait for thread termination 37.Sh SYNOPSIS 38.Fd #include <pthread.h> 39.Ft int 40.Fn pthread_join "pthread_t thread" "void **value_ptr" 41.Sh DESCRIPTION 42The 43.Fn pthread_join 44function suspends execution of the calling thread until the target 45.Fa thread 46terminates unless the target 47.Fa thread 48has already terminated. 49.Pp 50On return from a successful 51.Fn pthread_join 52call with a non-NULL 53.Fa value_ptr 54argument, the value passed to 55.Fn pthread_exit 56by the terminating thread is stored in the location referenced by 57.Fa value_ptr . 58When a 59.Fn pthread_join 60returns successfully, the target thread has been terminated. The results 61of multiple simultaneous calls to 62.Fn pthread_join 63specifying the same target thread are undefined. If the thread calling 64.Fn pthread_join 65is cancelled, then the target thread is not detached. 66.Pp 67A thread that has exited but remains unjoined counts against 68[_POSIX_THREAD_THREADS_MAX]. 69.Pp 70.Sh RETURN VALUES 71If successful, the 72.Fn pthread_join 73function will return zero. Otherwise an error number will be returned to 74indicate the error. 75.Sh ERRORS 76.Fn pthread_join 77will fail if: 78.Bl -tag -width Er 79.It Bq Er EINVAL 80The implementation has detected that the value specified by 81.Fa thread 82does not refer to a joinable thread. 83.It Bq Er ESRCH 84No thread could be found corresponding to that specified by the given 85thread ID, 86.Fa thread . 87.It Bq Er EDEADLK 88A deadlock was detected or the value of 89.Fa thread 90specifies the calling thread. 91.El 92.Pp 93.Sh SEE ALSO 94.Xr wait 2 , 95.Xr pthread_create 3 96.Sh STANDARDS 97.Fn pthread_join 98is expected to conform to IEEE 99.Pq Dq Tn POSIX 100Std 1003.1c when it is published. 101