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