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



PPRROOLLOOGG
       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.

NNAAMMEE
       pthread_attr_getinheritsched, pthread_attr_setinheritsched -- get and
       set the inheritsched attribute (RREEAALLTTIIMMEE TTHHRREEAADDSS)

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_attr_getinheritsched(const pthread_attr_t *restrict _a_t_t_r,
           int *restrict _i_n_h_e_r_i_t_s_c_h_e_d);
       int pthread_attr_setinheritsched(pthread_attr_t *_a_t_t_r,
           int _i_n_h_e_r_i_t_s_c_h_e_d);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___a_t_t_r___g_e_t_i_n_h_e_r_i_t_s_c_h_e_d() and _p_t_h_r_e_a_d___a_t_t_r___s_e_t_i_n_h_e_r_i_t_s_c_h_e_d()
       functions, respectively, shall get and set the _i_n_h_e_r_i_t_s_c_h_e_d attribute
       in the _a_t_t_r argument.

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

       The supported values of _i_n_h_e_r_i_t_s_c_h_e_d shall be:

       PTHREAD_INHERIT_SCHED
             Specifies that the thread scheduling attributes shall be
             inherited from the creating thread, and the scheduling attributes
             in this _a_t_t_r 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 _<_p_t_h_r_e_a_d_._h_> header.

       The following thread scheduling attributes defined by POSIX.1-2008 are
       affected by the _i_n_h_e_r_i_t_s_c_h_e_d attribute: scheduling policy
       (_s_c_h_e_d_p_o_l_i_c_y), scheduling parameters (_s_c_h_e_d_p_a_r_a_m), and scheduling
       contention scope (_c_o_n_t_e_n_t_i_o_n_s_c_o_p_e).

       The behavior is undefined if the value specified by the _a_t_t_r argument
       to _p_t_h_r_e_a_d___a_t_t_r___g_e_t_i_n_h_e_r_i_t_s_c_h_e_d() or _p_t_h_r_e_a_d___a_t_t_r___s_e_t_i_n_h_e_r_i_t_s_c_h_e_d()
       does not refer to an initialized thread attributes object.

RREETTUURRNN VVAALLUUEE
       If successful, the _p_t_h_r_e_a_d___a_t_t_r___g_e_t_i_n_h_e_r_i_t_s_c_h_e_d() and
       _p_t_h_r_e_a_d___a_t_t_r___s_e_t_i_n_h_e_r_i_t_s_c_h_e_d() functions shall return zero; otherwise,
       an error number shall be returned to indicate the error.

EERRRROORRSS
       The _p_t_h_r_e_a_d___a_t_t_r___s_e_t_i_n_h_e_r_i_t_s_c_h_e_d() function shall fail if:

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

       The _p_t_h_r_e_a_d___a_t_t_r___s_e_t_i_n_h_e_r_i_t_s_c_h_e_d() function may fail if:

       EEIINNVVAALL The value of _i_n_h_e_r_i_t_s_c_h_e_d is not valid.

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

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

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

       See _S_e_c_t_i_o_n _2_._9_._4, _T_h_r_e_a_d _S_c_h_e_d_u_l_i_n_g for further details on thread
       scheduling attributes and their default settings.

RRAATTIIOONNAALLEE
       If an implementation detects that the value specified by the _a_t_t_r
       argument to _p_t_h_r_e_a_d___a_t_t_r___g_e_t_i_n_h_e_r_i_t_s_c_h_e_d() or
       _p_t_h_r_e_a_d___a_t_t_r___s_e_t_i_n_h_e_r_i_t_s_c_h_e_d() does not refer to an initialized thread
       attributes object, it is recommended that the function should fail and
       report an [[EEIINNVVAALL]] error.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _p_t_h_r_e_a_d___a_t_t_r___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___a_t_t_r___g_e_t_s_c_o_p_e(),
       _p_t_h_r_e_a_d___a_t_t_r___g_e_t_s_c_h_e_d_p_o_l_i_c_y(), _p_t_h_r_e_a_d___a_t_t_r___g_e_t_s_c_h_e_d_p_a_r_a_m(),
       _p_t_h_r_e_a_d___c_r_e_a_t_e()

       The Base Definitions volume of POSIX.1-2017, <<pptthhrreeaadd..hh>>, <<sscchheedd..hh>>

CCOOPPYYRRIIGGHHTT
       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)
