SCHED_YIELD(3)             POSIX Programmer's Manual            SCHED_YIELD(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
       sched_yield -- yield the processor

SSYYNNOOPPSSIISS
       #include <sched.h>

       int sched_yield(void);

DDEESSCCRRIIPPTTIIOONN
       The _s_c_h_e_d___y_i_e_l_d() function shall force the running thread to relinquish
       the processor until it again becomes the head of its thread list. It
       takes no arguments.

RREETTUURRNN VVAALLUUEE
       The _s_c_h_e_d___y_i_e_l_d() function shall return 0 if it completes successfully;
       otherwise, it shall return a value of -1 and set _e_r_r_n_o to indicate the
       error.

EERRRROORRSS
       No errors are defined.

       _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
       The conceptual model for scheduling semantics in POSIX.1-2008 defines a
       set of thread lists. This set of thread lists is always present
       regardless of the scheduling options supported by the system. On a
       system where the Process Scheduling option is not supported, portable
       applications should not make any assumptions regarding whether threads
       from other processes will be on the same thread list.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       The Base Definitions volume of POSIX.1-2008, <<sscchheedd..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
       -- Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, Copyright (C) 2013 by the Institute of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is
       POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) 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.unix.org/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                  2013                       SCHED_YIELD(3)
