original/man3/pthread_detach.3

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