summaryrefslogtreecommitdiffstats
path: root/upstream/archlinux/man3p/pthread_condattr_getpshared.3p
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/archlinux/man3p/pthread_condattr_getpshared.3p
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/archlinux/man3p/pthread_condattr_getpshared.3p')
-rw-r--r--upstream/archlinux/man3p/pthread_condattr_getpshared.3p130
1 files changed, 130 insertions, 0 deletions
diff --git a/upstream/archlinux/man3p/pthread_condattr_getpshared.3p b/upstream/archlinux/man3p/pthread_condattr_getpshared.3p
new file mode 100644
index 00000000..d7f72d7f
--- /dev/null
+++ b/upstream/archlinux/man3p/pthread_condattr_getpshared.3p
@@ -0,0 +1,130 @@
+'\" et
+.TH PTHREAD_CONDATTR_GETPSHARED "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
+.\"
+.SH PROLOG
+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.
+.\"
+.SH NAME
+pthread_condattr_getpshared,
+pthread_condattr_setpshared
+\(em get and set the process-shared condition variable attributes
+.SH SYNOPSIS
+.LP
+.nf
+#include <pthread.h>
+.P
+int pthread_condattr_getpshared(const pthread_condattr_t *restrict \fIattr\fP,
+ int *restrict \fIpshared\fP);
+int pthread_condattr_setpshared(pthread_condattr_t *\fIattr\fP,
+ int \fIpshared\fP);
+.fi
+.SH DESCRIPTION
+The
+\fIpthread_condattr_getpshared\fR()
+function shall obtain the value of the
+.IR process-shared
+attribute from the attributes object referenced by
+.IR attr .
+.P
+The
+\fIpthread_condattr_setpshared\fR()
+function shall set the
+.IR process-shared
+attribute in an initialized attributes object referenced by
+.IR attr .
+.P
+The
+.IR process-shared
+attribute is set to PTHREAD_PROCESS_SHARED
+to permit a condition variable to be operated upon by any thread that
+has access to the memory where the condition variable is allocated,
+even if the condition variable is allocated in memory that is shared by
+multiple processes. See
+.IR "Section 2.9.9" ", " "Synchronization Object Copies and Alternative Mappings"
+for further requirements. The default value of the attribute
+is PTHREAD_PROCESS_PRIVATE.
+.P
+The behavior is undefined if the value specified by the
+.IR attr
+argument to
+\fIpthread_condattr_getpshared\fR()
+or
+\fIpthread_condattr_setpshared\fR()
+does not refer to an initialized condition variable attributes object.
+.SH "RETURN VALUE"
+If successful, the
+\fIpthread_condattr_setpshared\fR()
+function shall return zero; otherwise, an error number shall be
+returned to indicate the error.
+.P
+If successful, the
+\fIpthread_condattr_getpshared\fR()
+function shall return zero and store the value of the
+.IR process-shared
+attribute of
+.IR attr
+into the object referenced by the
+.IR pshared
+parameter. Otherwise, an error number shall be returned to indicate the
+error.
+.SH ERRORS
+The
+\fIpthread_condattr_setpshared\fR()
+function may fail if:
+.TP
+.BR EINVAL
+The new value specified for the attribute is outside the range of legal
+values for that attribute.
+.P
+These functions shall not return an error code of
+.BR [EINTR] .
+.LP
+.IR "The following sections are informative."
+.SH EXAMPLES
+None.
+.SH "APPLICATION USAGE"
+None.
+.SH RATIONALE
+If an implementation detects that the value specified by the
+.IR attr
+argument to
+\fIpthread_condattr_getpshared\fR()
+or
+\fIpthread_condattr_setpshared\fR()
+does not refer to an initialized condition variable attributes object,
+it is recommended that the function should fail and report an
+.BR [EINVAL]
+error.
+.SH "FUTURE DIRECTIONS"
+None.
+.SH "SEE ALSO"
+.ad l
+.IR "\fIpthread_create\fR\^(\|)",
+.IR "\fIpthread_cond_destroy\fR\^(\|)",
+.IR "\fIpthread_condattr_destroy\fR\^(\|)",
+.IR "\fIpthread_mutex_destroy\fR\^(\|)"
+.ad b
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<pthread.h>\fP"
+.\"
+.SH 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 .
+.PP
+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 .