PTHREAD_ATTR_GETSCHEDPARAM(3P)OSIX Programmer's ManuPaTlHREAD_ATTR_GETSCHEDPARAM(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_getschedparam, pthread_attr_setschedparam -- get and set
       the schedparam attribute

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_attr_getschedparam(const pthread_attr_t *restrict _a_t_t_r,
           struct sched_param *restrict _p_a_r_a_m);
       int pthread_attr_setschedparam(pthread_attr_t *restrict _a_t_t_r,
           const struct sched_param *restrict _p_a_r_a_m);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___a_t_t_r___g_e_t_s_c_h_e_d_p_a_r_a_m() and _p_t_h_r_e_a_d___a_t_t_r___s_e_t_s_c_h_e_d_p_a_r_a_m()
       functions, respectively, shall get and set the scheduling parameter
       attributes in the _a_t_t_r argument. The contents of the _p_a_r_a_m structure
       are defined in the _<_s_c_h_e_d_._h_> header. For the SCHED_FIFO and SCHED_RR
       policies, the only required member of _p_a_r_a_m is _s_c_h_e_d___p_r_i_o_r_i_t_y.

       For the SCHED_SPORADIC policy, the required members of the _p_a_r_a_m
       structure are _s_c_h_e_d___p_r_i_o_r_i_t_y, _s_c_h_e_d___s_s___l_o_w___p_r_i_o_r_i_t_y,
       _s_c_h_e_d___s_s___r_e_p_l___p_e_r_i_o_d, _s_c_h_e_d___s_s___i_n_i_t___b_u_d_g_e_t, and _s_c_h_e_d___s_s___m_a_x___r_e_p_l.  The
       specified _s_c_h_e_d___s_s___r_e_p_l___p_e_r_i_o_d must be greater than or equal to the
       specified _s_c_h_e_d___s_s___i_n_i_t___b_u_d_g_e_t for the function to succeed; if it is
       not, then the function shall fail. The value of _s_c_h_e_d___s_s___m_a_x___r_e_p_l shall
       be within the inclusive range [1,{SS_REPL_MAX}] for the function to
       succeed; if not, the function shall fail.  It is unspecified whether
       the _s_c_h_e_d___s_s___r_e_p_l___p_e_r_i_o_d and _s_c_h_e_d___s_s___i_n_i_t___b_u_d_g_e_t values are stored as
       provided by this function or are rounded to align with the resolution
       of the clock being used.

       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_s_c_h_e_d_p_a_r_a_m() or _p_t_h_r_e_a_d___a_t_t_r___s_e_t_s_c_h_e_d_p_a_r_a_m() 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_s_c_h_e_d_p_a_r_a_m() and
       _p_t_h_r_e_a_d___a_t_t_r___s_e_t_s_c_h_e_d_p_a_r_a_m() 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_s_c_h_e_d_p_a_r_a_m() 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_s_c_h_e_d_p_a_r_a_m() function may fail if:

       EEIINNVVAALL The value of _p_a_r_a_m 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.

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_s_c_h_e_d_p_a_r_a_m() or
       _p_t_h_r_e_a_d___a_t_t_r___s_e_t_s_c_h_e_d_p_a_r_a_m() 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_i_n_h_e_r_i_t_s_c_h_e_d(), _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___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_GETSCHEDPARAM(3)
