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