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 2021-03-22 "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 .PP
  33 .BI "int pthread_detach(pthread_t " thread );
  34 .fi
  35 .PP
  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 .PP
  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 ATTRIBUTES
  65 For an explanation of the terms used in this section, see
  66 .BR attributes (7).
  67 .ad l
  68 .nh
  69 .TS
  70 allbox;
  71 lbx lb lb
  72 l l l.
  73 Interface       Attribute       Value
  74 T{
  75 .BR pthread_detach ()
  76 T}      Thread safety   MT-Safe
  77 .TE
  78 .hy
  79 .ad
  80 .sp 1
  81 .SH CONFORMING TO
  82 POSIX.1-2001, POSIX.1-2008.
  83 .SH NOTES
  84 Once a thread has been detached, it can't be joined with
  85 .BR pthread_join (3)
  86 or be made joinable again.
  87 .PP
  88 A new thread can be created in a detached state using
  89 .BR pthread_attr_setdetachstate (3)
  90 to set the detached attribute of the
  91 .I attr
  92 argument of
  93 .BR pthread_create (3).
  94 .PP
  95 The detached attribute merely determines the behavior of the system
  96 when the thread terminates;
  97 it does not prevent the thread from being terminated
  98 if the process terminates using
  99 .BR exit (3)
 100 (or equivalently, if the main thread returns).
 101 .PP
 102 Either
 103 .BR pthread_join (3)
 104 or
 105 .BR pthread_detach ()
 106 should be called for each thread that an application creates,
 107 so that system resources for the thread can be released.
 108 (But note that the resources of any threads for which one of these
 109 actions has not been done will be freed when the process terminates.)
 110 .SH EXAMPLES
 111 The following statement detaches the calling thread:
 112 .PP
 113     pthread_detach(pthread_self());
 114 .SH SEE ALSO
 115 .BR pthread_attr_setdetachstate (3),
 116 .BR pthread_cancel (3),
 117 .BR pthread_create (3),
 118 .BR pthread_exit (3),
 119 .BR pthread_join (3),
 120 .BR pthreads (7)