diff options
Diffstat (limited to 'man-pages-posix-2017/man3p/pthread_attr_getinheritsched.3p')
| -rw-r--r-- | man-pages-posix-2017/man3p/pthread_attr_getinheritsched.3p | 161 |
1 files changed, 161 insertions, 0 deletions
diff --git a/man-pages-posix-2017/man3p/pthread_attr_getinheritsched.3p b/man-pages-posix-2017/man3p/pthread_attr_getinheritsched.3p new file mode 100644 index 0000000..47a2cd8 --- /dev/null +++ b/man-pages-posix-2017/man3p/pthread_attr_getinheritsched.3p @@ -0,0 +1,161 @@ +'\" et +.TH PTHREAD_ATTR_GETINHERITSCHED "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_getinheritsched, +pthread_attr_setinheritsched +\(em get and set the inheritsched attribute +(\fBREALTIME THREADS\fP) +.SH SYNOPSIS +.LP +.nf +#include <pthread.h> +.P +int pthread_attr_getinheritsched(const pthread_attr_t *restrict \fIattr\fP, + int *restrict \fIinheritsched\fP); +int pthread_attr_setinheritsched(pthread_attr_t *\fIattr\fP, + int \fIinheritsched\fP); +.fi +.SH DESCRIPTION +The +\fIpthread_attr_getinheritsched\fR() +and +\fIpthread_attr_setinheritsched\fR() +functions, respectively, shall get and set the +.IR inheritsched +attribute in the +.IR attr +argument. +.P +When the attributes objects are used by +\fIpthread_create\fR(), +the +.IR inheritsched +attribute determines how the other scheduling attributes of the created +thread shall be set. +.P +The supported values of +.IR inheritsched +shall be: +.IP PTHREAD_INHERIT_SCHED 6 +.br +Specifies that the thread scheduling attributes shall be inherited from +the creating thread, and the scheduling attributes in this +.IR attr +argument shall be ignored. +.IP PTHREAD_EXPLICIT_SCHED 6 +.br +Specifies that the thread scheduling attributes shall be set to the +corresponding values from this attributes object. +.P +The symbols PTHREAD_INHERIT_SCHED and PTHREAD_EXPLICIT_SCHED are +defined in the +.IR <pthread.h> +header. +.P +The following thread scheduling attributes defined by POSIX.1\(hy2008 are +affected by the +.IR inheritsched +attribute: scheduling policy (\c +.IR schedpolicy ), +scheduling parameters (\c +.IR schedparam ), +and scheduling contention scope (\c +.IR contentionscope ). +.P +The behavior is undefined if the value specified by the +.IR attr +argument to +\fIpthread_attr_getinheritsched\fR() +or +\fIpthread_attr_setinheritsched\fR() +does not refer to an initialized thread attributes object. +.SH "RETURN VALUE" +If successful, the +\fIpthread_attr_getinheritsched\fR() +and +\fIpthread_attr_setinheritsched\fR() +functions shall return zero; otherwise, an error number shall be +returned to indicate the error. +.SH ERRORS +The +\fIpthread_attr_setinheritsched\fR() +function shall fail if: +.TP +.BR ENOTSUP +An attempt was made to set the attribute to an unsupported value. +.P +The +\fIpthread_attr_setinheritsched\fR() +function may fail if: +.TP +.BR EINVAL +The value of +.IR inheritsched +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_getinheritsched\fR() +or +\fIpthread_attr_setinheritsched\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_getschedpolicy\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 . |