PTHREAD_CONDATTR_GETCLOCK(3)POSIX Programmer's ManuaPlTHREAD_CONDATTR_GETCLOCK(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_condattr_getclock, pthread_condattr_setclock -- get and set the
       clock selection condition variable attribute

SSYYNNOOPPSSIISS
       #include <pthread.h>

       int pthread_condattr_getclock(const pthread_condattr_t *restrict _a_t_t_r,
           clockid_t *restrict _c_l_o_c_k___i_d);
       int pthread_condattr_setclock(pthread_condattr_t *_a_t_t_r,
           clockid_t _c_l_o_c_k___i_d);

DDEESSCCRRIIPPTTIIOONN
       The _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___g_e_t_c_l_o_c_k() function shall obtain the value of the
       _c_l_o_c_k attribute from the attributes object referenced by _a_t_t_r.

       The _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___s_e_t_c_l_o_c_k() function shall set the _c_l_o_c_k attribute
       in an initialized attributes object referenced by _a_t_t_r.  If
       _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___s_e_t_c_l_o_c_k() is called with a _c_l_o_c_k___i_d argument that
       refers to a CPU-time clock, the call shall fail.

       The _c_l_o_c_k attribute is the clock ID of the clock that shall be used to
       measure the timeout service of _p_t_h_r_e_a_d___c_o_n_d___t_i_m_e_d_w_a_i_t().  The default
       value of the _c_l_o_c_k attribute shall refer to the system clock.

       The behavior is undefined if the value specified by the _a_t_t_r argument
       to _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___g_e_t_c_l_o_c_k() or _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___s_e_t_c_l_o_c_k() does not
       refer to an initialized condition variable attributes object.

RREETTUURRNN VVAALLUUEE
       If successful, the _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___g_e_t_c_l_o_c_k() function shall return
       zero and store the value of the clock attribute of _a_t_t_r into the object
       referenced by the _c_l_o_c_k___i_d argument. Otherwise, an error number shall
       be returned to indicate the error.

       If successful, the _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___s_e_t_c_l_o_c_k() function shall return
       zero; otherwise, an error number shall be returned to indicate the
       error.

EERRRROORRSS
       The _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___s_e_t_c_l_o_c_k() function may fail if:

       EEIINNVVAALL The value specified by _c_l_o_c_k___i_d does not refer to a known clock,
              or is a CPU-time clock.

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

RRAATTIIOONNAALLEE
       If an implementation detects that the value specified by the _a_t_t_r
       argument to _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___g_e_t_c_l_o_c_k() or _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___s_e_t_c_l_o_c_k()
       does not refer to an initialized condition variable 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___c_o_n_d___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___c_o_n_d___t_i_m_e_d_w_a_i_t(),
       _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___d_e_s_t_r_o_y(), _p_t_h_r_e_a_d___c_o_n_d_a_t_t_r___g_e_t_p_s_h_a_r_e_d(),
       _p_t_h_r_e_a_d___c_r_e_a_t_e(), _p_t_h_r_e_a_d___m_u_t_e_x___d_e_s_t_r_o_y()

       The Base Definitions volume of POSIX.1-2017, <<pptthhrreeaadd..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_CONDATTR_GETCLOCK(3)
