summaryrefslogtreecommitdiffstats
path: root/upstream/mageia-cauldron/man3p/pthread_attr_getschedpolicy.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/mageia-cauldron/man3p/pthread_attr_getschedpolicy.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/mageia-cauldron/man3p/pthread_attr_getschedpolicy.3p')
-rw-r--r--upstream/mageia-cauldron/man3p/pthread_attr_getschedpolicy.3p135
1 files changed, 135 insertions, 0 deletions
diff --git a/upstream/mageia-cauldron/man3p/pthread_attr_getschedpolicy.3p b/upstream/mageia-cauldron/man3p/pthread_attr_getschedpolicy.3p
new file mode 100644
index 00000000..f1753f5f
--- /dev/null
+++ b/upstream/mageia-cauldron/man3p/pthread_attr_getschedpolicy.3p
@@ -0,0 +1,135 @@
+'\" et
+.TH PTHREAD_ATTR_GETSCHEDPOLICY "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_attr_getschedpolicy,
+pthread_attr_setschedpolicy
+\(em get and set the schedpolicy attribute
+(\fBREALTIME THREADS\fP)
+.SH SYNOPSIS
+.LP
+.nf
+#include <pthread.h>
+.P
+int pthread_attr_getschedpolicy(const pthread_attr_t *restrict \fIattr\fP,
+ int *restrict \fIpolicy\fP);
+int pthread_attr_setschedpolicy(pthread_attr_t *\fIattr\fP, int \fIpolicy\fP);
+.fi
+.SH DESCRIPTION
+The
+\fIpthread_attr_getschedpolicy\fR()
+and
+\fIpthread_attr_setschedpolicy\fR()
+functions, respectively, shall get and set the
+.IR schedpolicy
+attribute in the
+.IR attr
+argument.
+.P
+The supported values of
+.IR policy
+shall include SCHED_FIFO, SCHED_RR, and SCHED_OTHER,
+which are defined in the
+.IR <sched.h>
+header. When threads executing with the scheduling policy SCHED_FIFO,
+SCHED_RR,
+or SCHED_SPORADIC
+are waiting on a mutex, they shall acquire the mutex in priority order
+when the mutex is unlocked.
+.P
+The behavior is undefined if the value specified by the
+.IR attr
+argument to
+\fIpthread_attr_getschedpolicy\fR()
+or
+\fIpthread_attr_setschedpolicy\fR()
+does not refer to an initialized thread attributes object.
+.SH "RETURN VALUE"
+If successful, the
+\fIpthread_attr_getschedpolicy\fR()
+and
+\fIpthread_attr_setschedpolicy\fR()
+functions shall return zero; otherwise, an error number shall be
+returned to indicate the error.
+.SH ERRORS
+The
+\fIpthread_attr_setschedpolicy\fR()
+function shall fail if:
+.TP
+.BR ENOTSUP
+An attempt was made to set the attribute to an unsupported value.
+.P
+The
+\fIpthread_attr_setschedpolicy\fR()
+function may fail if:
+.TP
+.BR EINVAL
+The value of
+.IR policy
+is not valid.
+.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"
+After these attributes have been set, a thread can be created with the
+specified attributes using
+\fIpthread_create\fR().
+Using these routines does not affect the current running thread.
+.P
+See
+.IR "Section 2.9.4" ", " "Thread Scheduling"
+for further details on thread scheduling attributes and their
+default settings.
+.SH RATIONALE
+If an implementation detects that the value specified by the
+.IR attr
+argument to
+\fIpthread_attr_getschedpolicy\fR()
+or
+\fIpthread_attr_setschedpolicy\fR()
+does not refer to an initialized thread 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_attr_destroy\fR\^(\|)",
+.IR "\fIpthread_attr_getscope\fR\^(\|)",
+.IR "\fIpthread_attr_getinheritsched\fR\^(\|)",
+.IR "\fIpthread_attr_getschedparam\fR\^(\|)",
+.IR "\fIpthread_create\fR\^(\|)"
+.ad b
+.P
+The Base Definitions volume of POSIX.1\(hy2017,
+.IR "\fB<pthread.h>\fP",
+.IR "\fB<sched.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 .