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