summaryrefslogtreecommitdiffstats
path: root/man3/pthread_attr_setdetachstate.3
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:40:15 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:40:15 +0000
commit399644e47874bff147afb19c89228901ac39340e (patch)
tree1c4c0b733f4c16b5783b41bebb19194a9ef62ad1 /man3/pthread_attr_setdetachstate.3
parentInitial commit. (diff)
downloadmanpages-399644e47874bff147afb19c89228901ac39340e.tar.xz
manpages-399644e47874bff147afb19c89228901ac39340e.zip
Adding upstream version 6.05.01.upstream/6.05.01
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'man3/pthread_attr_setdetachstate.3')
-rw-r--r--man3/pthread_attr_setdetachstate.3116
1 files changed, 116 insertions, 0 deletions
diff --git a/man3/pthread_attr_setdetachstate.3 b/man3/pthread_attr_setdetachstate.3
new file mode 100644
index 0000000..c984943
--- /dev/null
+++ b/man3/pthread_attr_setdetachstate.3
@@ -0,0 +1,116 @@
+'\" t
+.\" Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
+.\" <mtk.manpages@gmail.com>
+.\"
+.\" SPDX-License-Identifier: Linux-man-pages-copyleft
+.\"
+.TH pthread_attr_setdetachstate 3 2023-07-20 "Linux man-pages 6.05.01"
+.SH NAME
+pthread_attr_setdetachstate, pthread_attr_getdetachstate \-
+set/get detach state attribute in thread attributes object
+.SH LIBRARY
+POSIX threads library
+.RI ( libpthread ", " \-lpthread )
+.SH SYNOPSIS
+.nf
+.B #include <pthread.h>
+.PP
+.BI "int pthread_attr_setdetachstate(pthread_attr_t *" attr \
+", int " detachstate );
+.BI "int pthread_attr_getdetachstate(const pthread_attr_t *" attr ,
+.BI " int *" detachstate );
+.fi
+.SH DESCRIPTION
+The
+.BR pthread_attr_setdetachstate ()
+function sets the detach state attribute of the
+thread attributes object referred to by
+.I attr
+to the value specified in
+.IR detachstate .
+The detach state attribute determines whether a thread created using
+the thread attributes object
+.I attr
+will be created in a joinable or a detached state.
+.PP
+The following values may be specified in
+.IR detachstate :
+.TP
+.B PTHREAD_CREATE_DETACHED
+Threads that are created using
+.I attr
+will be created in a detached state.
+.TP
+.B PTHREAD_CREATE_JOINABLE
+Threads that are created using
+.I attr
+will be created in a joinable state.
+.PP
+The default setting of the detach state attribute in a newly initialized
+thread attributes object is
+.BR PTHREAD_CREATE_JOINABLE .
+.PP
+The
+.BR pthread_attr_getdetachstate ()
+returns the detach state attribute of the thread attributes object
+.I attr
+in the buffer pointed to by
+.IR detachstate .
+.SH RETURN VALUE
+On success, these functions return 0;
+on error, they return a nonzero error number.
+.SH ERRORS
+.BR pthread_attr_setdetachstate ()
+can fail with the following error:
+.TP
+.B EINVAL
+An invalid value was specified in
+.IR detachstate .
+.SH ATTRIBUTES
+For an explanation of the terms used in this section, see
+.BR attributes (7).
+.TS
+allbox;
+lbx lb lb
+l l l.
+Interface Attribute Value
+T{
+.na
+.nh
+.BR pthread_attr_setdetachstate (),
+.BR pthread_attr_getdetachstate ()
+T} Thread safety MT-Safe
+.TE
+.sp 1
+.SH STANDARDS
+POSIX.1-2008.
+.SH HISTORY
+POSIX.1-2001.
+.SH NOTES
+See
+.BR pthread_create (3)
+for more details on detached and joinable threads.
+.PP
+A thread that is created in a joinable state should
+eventually either be joined using
+.BR pthread_join (3)
+or detached using
+.BR pthread_detach (3);
+see
+.BR pthread_create (3).
+.PP
+It is an error to specify the thread ID of
+a thread that was created in a detached state
+in a later call to
+.BR pthread_detach (3)
+or
+.BR pthread_join (3).
+.SH EXAMPLES
+See
+.BR pthread_attr_init (3).
+.SH SEE ALSO
+.BR pthread_attr_init (3),
+.BR pthread_create (3),
+.BR pthread_detach (3),
+.BR pthread_join (3),
+.BR pthreads (7)