[apple/libpthread.git] / man / pthread_join.3

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