[thirdparty/man-pages.git] / man3 / pthread_detach.3

.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
.\"     <mtk.manpages@gmail.com>
.\"
.\" Permission is granted to make and distribute verbatim copies of this
.\" manual provided the copyright notice and this permission notice are
.\" preserved on all copies.
.\"
.\" Permission is granted to copy and distribute modified versions of this
.\" manual under the conditions for verbatim copying, provided that the
.\" entire resulting derived work is distributed under the terms of a
.\" permission notice identical to this one.
.\"
.\" Since the Linux kernel and libraries are constantly changing, this
.\" manual page may be incorrect or out-of-date.  The author(s) assume no
.\" responsibility for errors or omissions, or for damages resulting from
.\" the use of the information contained herein.  The author(s) may not
.\" have taken the same level of care in the production of this manual,
.\" which is licensed free of charge, as they might when working
.\" professionally.
.\"
.\" Formatted or processed versions of this manual, if unaccompanied by
.\" the source, must acknowledge the copyright and authors of this work.
.\"
.TH PTHREAD_DETACH 3 2008-10-24 "Linux" "Linux Programmer's Manual"
.SH NAME
pthread_detach \- detach a thread
.SH SYNOPSIS
.nf
.B #include <pthread.h>

.BI "int pthread_detach(pthread_t " thread );
.fi
.sp
Compile and link with \fI\-pthread\fP.
.SH DESCRIPTION
The
.BR pthread_detach ()
function marks the thread identified by
.IR thread
as detached.
When a detached thread terminates,
its resources are automatically released back to the system without
the need for another thread to join with the terminated the thread.

Attempting to detach an already detached thread results
in unspecified behavior.
.SH RETURN VALUE
On success,
.BR pthread_detach ()
returns 0;
on error, it returns an error number.
.SH ERRORS
.TP
.B EINVAL
.I thread
is not a joinable thread.
.TP
.B ESRCH
No thread could be found with the given thread ID.
.SH CONFORMING TO
POSIX.1-2001.
.SH NOTES
Once a thread has been detached, it can't be joined with
.BR pthread_join (3)
or be made joinable again.

A new thread can be created in a detached state using
.BR pthread_attr_setdetachstate (3)
to set the detached attribute of the
.I attr
argument of
.BR pthread_create (3).

The detached attribute merely determines the behavior of the system
when the thread terminates;
it does not prevent the thread from being terminated
if the process terminates using
.BR exit (3)
(or equivalently, if the main thread returns).

Either
.BR pthread_join (3)
or
.BR pthread_detach ()
should be called for each thread that an application creates,
so that system resources for the thread can be released.
(But note that the resources of all threads are freed when the
process terminates.)
.SH EXAMPLE
The following statement detaches the calling thread:

    pthread_detach(pthread_self());
.SH SEE ALSO
.BR pthread_attr_setdetachstate (3),
.BR pthread_cancel (3),
.BR pthread_create (3),
.BR pthread_exit (3),
.BR pthread_join (3),
.BR pthreads (7)
Commit	Line	Data
b290aa63 MK	1	.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
	2	.\" <mtk.manpages@gmail.com>
	3	.\"
	4	.\" Permission is granted to make and distribute verbatim copies of this
	5	.\" manual provided the copyright notice and this permission notice are
	6	.\" preserved on all copies.
	7	.\"
	8	.\" Permission is granted to copy and distribute modified versions of this
	9	.\" manual under the conditions for verbatim copying, provided that the
	10	.\" entire resulting derived work is distributed under the terms of a
	11	.\" permission notice identical to this one.
	12	.\"
	13	.\" Since the Linux kernel and libraries are constantly changing, this
	14	.\" manual page may be incorrect or out-of-date. The author(s) assume no
	15	.\" responsibility for errors or omissions, or for damages resulting from
	16	.\" the use of the information contained herein. The author(s) may not
	17	.\" have taken the same level of care in the production of this manual,
	18	.\" which is licensed free of charge, as they might when working
	19	.\" professionally.
	20	.\"
	21	.\" Formatted or processed versions of this manual, if unaccompanied by
	22	.\" the source, must acknowledge the copyright and authors of this work.
	23	.\"
	24	.TH PTHREAD_DETACH 3 2008-10-24 "Linux" "Linux Programmer's Manual"
	25	.SH NAME
	26	pthread_detach \- detach a thread
	27	.SH SYNOPSIS
	28	.nf
	29	.B #include <pthread.h>
	30
	31	.BI "int pthread_detach(pthread_t " thread );
	32	.fi
	33	.sp
	34	Compile and link with \fI\-pthread\fP.
	35	.SH DESCRIPTION
	36	The
	37	.BR pthread_detach ()
	38	function marks the thread identified by
	39	.IR thread
	40	as detached.
	41	When a detached thread terminates,
	42	its resources are automatically released back to the system without
	43	the need for another thread to join with the terminated the thread.
	44
	45	Attempting to detach an already detached thread results
	46	in unspecified behavior.
	47	.SH RETURN VALUE
	48	On success,
	49	.BR pthread_detach ()
	50	returns 0;
	51	on error, it returns an error number.
	52	.SH ERRORS
	53	.TP
	54	.B EINVAL
	55	.I thread
	56	is not a joinable thread.
	57	.TP
	58	.B ESRCH
	59	No thread could be found with the given thread ID.
	60	.SH CONFORMING TO
	61	POSIX.1-2001.
	62	.SH NOTES
	63	Once a thread has been detached, it can't be joined with
	64	.BR pthread_join (3)
65	or be made joinable again.
66
67	A new thread can be created in a detached state using
68	.BR pthread_attr_setdetachstate (3)
69	to set the detached attribute of the
70	.I attr
71	argument of
72	.BR pthread_create (3).
73
74	The detached attribute merely determines the behavior of the system
75	when the thread terminates;
76	it does not prevent the thread from being terminated
77	if the process terminates using
78	.BR exit (3)
79	(or equivalently, if the main thread returns).
80
81	Either
82	.BR pthread_join (3)
83	or
84	.BR pthread_detach ()
85	should be called for each thread that an application creates,
86	so that system resources for the thread can be released.
87	(But note that the resources of all threads are freed when the
88	process terminates.)
89	.SH EXAMPLE
90	The following statement detaches the calling thread:
91
92	pthread_detach(pthread_self());
93	.SH SEE ALSO
94	.BR pthread_attr_setdetachstate (3),
95	.BR pthread_cancel (3),
96	.BR pthread_create (3),
97	.BR pthread_exit (3),
98	.BR pthread_join (3),
99	.BR pthreads (7)