PTHREAD_C...R_DESTROY(3P)

πŸ’– PTHREAD_C...R_DESTROY(3P) πŸ’–

okay bestie, so this is a page straight outta the POSIX Programmer's Manual β€” like, the official IEEE/Open Group one, not the Linux one. sit down, hydrate, and let's get into it ✨


🌸 PROLOG 🌸

This manual page is part of the POSIX Programmer's Manual. Heads up though, fr fr: the Linux implementation of this interface may differ (so go check the corresponding Linux manual page for the deets on Linux behavior), or the interface may not even be implemented on Linux at all. πŸ’€


πŸ‘‘ NAME πŸ‘‘

pthread_condattr_destroy, pthread_condattr_init β€” destroy and initialize the condition variable attributes object. iconic behavior, truly.


✨ SYNOPSIS ✨

#include <pthread.h>

int pthread_condattr_destroy(pthread_condattr_t *attr);
int pthread_condattr_init(pthread_condattr_t *attr);

πŸ¦‹ DESCRIPTION πŸ¦‹

So pthread_condattr_destroy() shall destroy a condition variable attributes object β€” and the object becomes, in effect, uninitialized. An implementation may cause pthread_condattr_destroy() to set the object referenced by attr to an invalid value. The good news: a destroyed attr attributes object can be reinitialized using pthread_condattr_init(). The bad news: the results of otherwise referencing the object after it has been destroyed are undefined. no cap. πŸ™ˆ

Then pthread_condattr_init() shall initialize a condition variable attributes object attr with the default value for all of the attributes defined by the implementation.

Results are undefined if pthread_condattr_init() is called specifying an already initialized attr attributes object. double-init? we don't do that here. πŸ’…

After a condition variable attributes object has been used to initialize one or more condition variables, any function affecting the attributes object (including destruction) shall not affect any previously initialized condition variables. so like, the attributes object is a vibe-setter, not a live wire β€” once the cond vars are born, they're independent. periodt. 🫢

This volume of POSIX.1‐2017 requires two attributes: the clock attribute and the process-shared attribute. slay.

Additional attributes, their default values, and the names of the associated functions to get and set those attribute values are implementation-defined.

The behavior is undefined if the value specified by the attr argument to pthread_condattr_destroy() does not refer to an initialized condition variable attributes object. like, don't pass it garbage, bestie, it will simply not know what to do 😭


⭐ RETURN VALUE ⭐

If successful, the pthread_condattr_destroy() and pthread_condattr_init() functions shall return zero; otherwise, an error number shall be returned to indicate the error. cute, simple, no ✨surprises✨.


πŸ’€ ERRORS πŸ’€

The pthread_condattr_init() function shall fail if:

  • ENOMEM β€” Insufficient memory exists to initialize the condition variable attributes object. (not enough room, the vibes could not be allocated 🫠)

These functions shall not return an error code of [EINTR].

The following sections are informative.


πŸŽ€ EXAMPLES πŸŽ€

None. (yes really. nothing. the void. empty. πŸ“)


🌈 APPLICATION USAGE 🌈

None. (again β€” nothing here, bestie, go touch grass πŸ’œ)


🧚 RATIONALE 🧚

A process-shared attribute has been defined for condition variables for the same reason it has been defined for mutexes. consistency, we love to see it.

If an implementation detects that the value specified by the attr argument to pthread_condattr_destroy() does not refer to an initialized condition variable attributes object, it is recommended that the function should fail and report an [EINVAL] error. (recommended! not required! iykyk.)

See also pthread_attr_destroy() and pthread_mutex_destroy().


πŸ”₯ FUTURE DIRECTIONS πŸ”₯

None. (the future is, apparently, a peaceful and unbothered place.)


πŸ’… SEE ALSO πŸ’…

  • pthread_attr_destroy()
  • pthread_cond_destroy()
  • pthread_condattr_getpshared()
  • pthread_create()
  • pthread_mutex_destroy()

The Base Definitions volume of POSIX.1‐2017, <pthread.h>


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!! every flag, every error, every <pthread.h>, all of it. go forth and init/destroy responsibly. mwah πŸ’…βœ¨

okay so this one was brought to you by IEEE/The Open Group, 2017 β€” that's the source, that's the date, that's the whole vibe check, and that's the end of the page πŸŽ€

πŸ“¦ where this page comes from