PTHREAD_ATTR_GETINHERITSCHEDP(O3S)IX Programmer's MaPnTuHaRlEAD_ATTR_GETINHERITSCHED(3)



PROLOG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.

NAME
       pthread_attr_getinheritsched, pthread_attr_setinheritsched -- get and
       set the inheritsched attribute (REALTIME THREADS)

SYNOPSIS
       #include <pthread.h>

       int pthread_attr_getinheritsched(const pthread_attr_t *restrict attr,
           int *restrict inheritsched);
       int pthread_attr_setinheritsched(pthread_attr_t *attr,
           int inheritsched);

DESCRIPTION
       The pthread__attr__getinheritsched() and pthread__attr__setinheritsched()
       functions, respectively, shall get and set the inheritsched attribute
       in the attr argument.

       When the attributes objects are used by pthread__create(), the
       inheritsched attribute determines how the other scheduling attributes
       of the created thread shall be set.

       The supported values of inheritsched shall be:

       PTHREAD_INHERIT_SCHED
             Specifies that the thread scheduling attributes shall be
             inherited from the creating thread, and the scheduling attributes
             in this attr argument shall be ignored.

       PTHREAD_EXPLICIT_SCHED
             Specifies that the thread scheduling attributes shall be set to
             the corresponding values from this attributes object.

       The symbols PTHREAD_INHERIT_SCHED and PTHREAD_EXPLICIT_SCHED are
       defined in the <pthread.h> header.

       The following thread scheduling attributes defined by POSIX.1-2008 are
       affected by the inheritsched attribute: scheduling policy
       (schedpolicy), scheduling parameters (schedparam), and scheduling
       contention scope (contentionscope).

       The behavior is undefined if the value specified by the attr argument
       to pthread__attr__getinheritsched() or pthread__attr__setinheritsched()
       does not refer to an initialized thread attributes object.

RETURN VALUE
       If successful, the pthread__attr__getinheritsched() and
       pthread__attr__setinheritsched() functions shall return zero; otherwise,
       an error number shall be returned to indicate the error.

ERRORS
       The pthread__attr__setinheritsched() function shall fail if:

       ENOTSUP
              An attempt was made to set the attribute to an unsupported
              value.

       The pthread__attr__setinheritsched() function may fail if:

       EINVAL The value of inheritsched is not valid.

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

       The following sections are informative.

EXAMPLES
       None.

APPLICATION USAGE
       After these attributes have been set, a thread can be created with the
       specified attributes using pthread__create().  Using these routines does
       not affect the current running thread.

       See Section 2.9.4, Thread Scheduling for further details on thread
       scheduling attributes and their default settings.

RATIONALE
       If an implementation detects that the value specified by the attr
       argument to pthread__attr__getinheritsched() or
       pthread__attr__setinheritsched() does not refer to an initialized thread
       attributes object, it is recommended that the function should fail and
       report an [EINVAL] error.

FUTURE DIRECTIONS
       None.

SEE ALSO
       pthread__attr__destroy(), pthread__attr__getscope(),
       pthread__attr__getschedpolicy(), pthread__attr__getschedparam(),
       pthread__create()

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

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 .



IEEE/The Open Group                  2017      PTHREAD_ATTR_GETINHERITSCHED(3)
