PTHREAD_A...ETACHSTATE(3P)

💅 PTHREAD_A...ETACHSTATE(3P) — POSIX Programmer's Manual

okay bestie, before we even start, a lil PROLOG moment 🫶

This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux. no cap, check ur local docs before u commit to anything 💀

---

✨ NAME ✨

pthread_attr_getdetachstate, pthread_attr_setdetachstate — get and set the detachstate attribute

like. the whole job. get it, set it, move on. iconic behavior fr fr 👑

---

🌸 SYNOPSIS 🌸

#include <pthread.h>

int pthread_attr_getdetachstate(const pthread_attr_t *attr,
    int *detachstate);
int pthread_attr_setdetachstate(pthread_attr_t *attr, int detachstate);

---

💖 DESCRIPTION 💖

okay so the detachstate attribute is literally the thing that controls whether the thread is created in a detached state. that's it. that's the vibe check.

and listen — if the thread is created detached, then using the ID of the newly created thread with the pthread_detach() or pthread_join() function is an error. not a "oops my bad" error, an actual error. 🚨

So. The pthread_attr_getdetachstate() and pthread_attr_setdetachstate() functions, respectively, shall get and set the detachstate attribute in the attr object. get girlies get, set girlies set. 💅

For pthread_attr_getdetachstate(), detachstate shall be set to either PTHREAD_CREATE_DETACHED or PTHREAD_CREATE_JOINABLE.

For pthread_attr_setdetachstate(), the application shall set detachstate to either PTHREAD_CREATE_DETACHED or PTHREAD_CREATE_JOINABLE.

A value of PTHREAD_CREATE_DETACHED shall cause all threads created with attr to be in the detached state, whereas using a value of PTHREAD_CREATE_JOINABLE shall cause all threads created with attr to be in the joinable state. it's giving "this attr is your whole personality now" 🌈

The default value of the detachstate attribute shall be PTHREAD_CREATE_JOINABLE. so if u do nothing, u get joinable. the default is the default, periodt.

⚠️ The behavior is undefined if the value specified by the attr argument to pthread_attr_getdetachstate() or pthread_attr_setdetachstate() does not refer to an initialized thread attributes object. undefined behavior bestie!! we do NOT do that. 🫠

---

🦋 RETURN VALUE 🦋

Upon successful completion, pthread_attr_getdetachstate() and pthread_attr_setdetachstate() shall return a value of 0; otherwise, an error number shall be returned to indicate the error. zero = slay, anything else = read the number, it's telling u something 💀

The pthread_attr_getdetachstate() function stores the value of the detachstate attribute in detachstate if successful. yes girl, it actually writes to ur pointer. that's the whole point. 🎀

---

🔥 ERRORS 🔥

The pthread_attr_setdetachstate() function shall fail if:

• EINVAL — The value of detachstate was not valid

These functions shall not return an error code of [EINTR]. nope, not a thing here, don't @ me 🙈

The following sections are informative.

---

⭐ EXAMPLES ⭐

Retrieving the detachstate Attribute

This example shows how to obtain the detachstate attribute of a thread attribute object. look at her go 🧚

#include <pthread.h>

pthread_attr_t thread_attr;
int            detachstate;
int            rc;

/* code initializing thread_attr */
...

rc = pthread_attr_getdetachstate (&thread_attr, &detachstate);
if (rc!=0) {
    /* handle error */
    ...
}
else {
    /* legal values for detachstate are:
     * PTHREAD_CREATE_DETACHED or PTHREAD_CREATE_JOINABLE
     */
     ...
}

---

💜 APPLICATION USAGE 💜

None. literally nothing. the void. we love a minimal section 💅

---

🌈 RATIONALE 🌈

If an implementation detects that the value specified by the attr argument to pthread_attr_getdetachstate() or pthread_attr_setdetachstate() does not refer to an initialized thread attributes object, it is recommended that the function should fail and report an [EINVAL] error. recommended, bestie — not required. iykyk. 👀

---

🎀 FUTURE DIRECTIONS 🎀

None. the future is empty. no notes. ✨

---

🌸 SEE ALSO 🌸

• pthread_attr_destroy()
• pthread_attr_getstacksize()
• pthread_create()

The Base Definitions volume of POSIX.1‐2017, <pthread.h> — go read the header file, it's free and it's right there 🫶

---

👑 COPYRIGHT 👑

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .

---

and that's the whole page bestie!! IEEE/The Open Group, 2017 — mwah, go forth and detach responsibly 💖✨🎀