[apple/libc.git] / pthreads / pthread_detach.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: src/lib/libc_r/man/pthread_detach.3,v 1.6.2.5 2001/08/17 15:42:51 ru Exp $
.\"
.Dd April 4, 1996
.Dt PTHREAD_DETACH 3
.Os
.Sh NAME
.Nm pthread_detach
.Nd detach a thread
.Sh SYNOPSIS
.Fd #include <pthread.h>
.Ft int
.Fo pthread_detach
.Fa "pthread_t thread"
.Fc
.Sh DESCRIPTION
The
.Fn pthread_detach
function is used to indicate to the implementation that storage for the
thread
.Fa thread
can be reclaimed when the thread terminates.
If
.Fa thread
has not terminated,
.Fn pthread_detach
will not cause it to terminate.
The effect of multiple
.Fn pthread_detach
calls on the same target thread is unspecified.
.Sh RETURN VALUES
If successful,  the
.Fn pthread_detach
function will return zero.
Otherwise, an error number will be returned to
indicate the error.
Note that the function does not change the value
of errno, as it did for some drafts of the standard.
These early drafts
also passed a pointer to pthread_t as the argument.
Beware!
.Sh ERRORS
.Fn pthread_detach
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 .
.El
.Sh SEE ALSO
.Xr pthread_join 3
.Sh STANDARDS
.Fn pthread_detach
conforms to
.St -p1003.1-96 .
Commit	Line	Data
5b2abdfb 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	.\"
	31	.\" $FreeBSD: src/lib/libc_r/man/pthread_detach.3,v 1.6.2.5 2001/08/17 15:42:51 ru Exp $
	32	.\"
	33	.Dd April 4, 1996
	34	.Dt PTHREAD_DETACH 3
	35	.Os
	36	.Sh NAME
	37	.Nm pthread_detach
	38	.Nd detach a thread
	39	.Sh SYNOPSIS
	40	.Fd #include <pthread.h>
	41	.Ft int
224c7076 A	42	.Fo pthread_detach
	43	.Fa "pthread_t thread"
	44	.Fc
5b2abdfb A	45	.Sh DESCRIPTION
	46	The
	47	.Fn pthread_detach
	48	function is used to indicate to the implementation that storage for the
	49	thread
	50	.Fa thread
	51	can be reclaimed when the thread terminates.
	52	If
	53	.Fa thread
	54	has not terminated,
	55	.Fn pthread_detach
	56	will not cause it to terminate.
	57	The effect of multiple
	58	.Fn pthread_detach
	59	calls on the same target thread is unspecified.
	60	.Sh RETURN VALUES
	61	If successful, the
	62	.Fn pthread_detach
	63	function will return zero.
224c7076	64	Otherwise, an error number will be returned to
5b2abdfb A	65	indicate the error.
5b2abdfb A	66	Note that the function does not change the value
224c7076	67	of errno, as it did for some drafts of the standard.
5b2abdfb A	68	These early drafts
	69	also passed a pointer to pthread_t as the argument.
	70	Beware!
	71	.Sh ERRORS
	72	.Fn pthread_detach
	73	will fail if:
	74	.Bl -tag -width Er
	75	.It Bq Er EINVAL
	76	The implementation has detected that the value specified by
	77	.Fa thread
	78	does not refer to a joinable thread.
	79	.It Bq Er ESRCH
	80	No thread could be found corresponding to that specified by the given
	81	thread ID,
	82	.Fa thread .
	83	.El
	84	.Sh SEE ALSO
	85	.Xr pthread_join 3
	86	.Sh STANDARDS
	87	.Fn pthread_detach
	88	conforms to
	89	.St -p1003.1-96 .