1.\" $OpenBSD: pthread_join.3,v 1.10 2013/06/05 03:44:50 tedu Exp $ 2.\" 3.\" Copyright (c) 1996-1998 John Birrell <jb@cimlogic.com.au>. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by John Birrell. 17.\" 4. Neither the name of the author nor the names of any co-contributors 18.\" may be used to endorse or promote products derived from this software 19.\" without specific prior written permission. 20.\" 21.\" THIS SOFTWARE IS PROVIDED BY JOHN BIRRELL AND CONTRIBUTORS ``AS IS'' AND 22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31.\" SUCH DAMAGE. 32.\" 33.\" $FreeBSD: pthread_join.3,v 1.6 1999/08/28 00:03:06 peter Exp $ 34.\" 35.Dd $Mdocdate: June 5 2013 $ 36.Dt PTHREAD_JOIN 3 37.Os 38.Sh NAME 39.Nm pthread_join 40.Nd wait for thread termination 41.Sh SYNOPSIS 42.In pthread.h 43.Ft int 44.Fn pthread_join "pthread_t thread" "void **value_ptr" 45.Sh DESCRIPTION 46The 47.Fn pthread_join 48function suspends execution of the calling thread until the target 49.Fa thread 50terminates unless the target 51.Fa thread 52has already terminated. 53.Pp 54On return from a successful 55.Fn pthread_join 56call with a non-NULL 57.Fa value_ptr 58argument, the value passed to 59.Fn pthread_exit 60by the terminating thread is stored in the location referenced by 61.Fa value_ptr . 62When a 63.Fn pthread_join 64returns successfully, the target thread has been terminated. 65The results of multiple simultaneous calls to 66.Fn pthread_join 67specifying the same target thread are undefined. 68If the thread calling 69.Fn pthread_join 70is cancelled, then the target thread is not detached. 71.Pp 72A thread that has exited but remains unjoined counts against 73[_POSIX_THREAD_THREADS_MAX]. 74.Sh RETURN VALUES 75If successful, the 76.Fn pthread_join 77function will return zero. 78Otherwise an error number will be returned to indicate the error. 79.Sh ERRORS 80.Fn pthread_join 81will fail if: 82.Bl -tag -width Er 83.It Bq Er EINVAL 84The implementation has detected that the value specified by 85.Fa thread 86does not refer to a joinable thread. 87.It Bq Er ESRCH 88No thread could be found corresponding to that specified by the given 89thread ID, 90.Fa thread . 91.It Bq Er EDEADLK 92A deadlock was detected or the value of 93.Fa thread 94specifies the calling thread. 95.El 96.Sh SEE ALSO 97.Xr wait 2 , 98.Xr pthread_create 3 99.Sh STANDARDS 100.Fn pthread_join 101conforms to 102.St -p1003.1-96 . 103