pthread_yield(3)           Library Functions Manual           pthread_yield(3)

NAME
       pthread_yield - yield the processor

LIBRARY
       POSIX threads library (libpthread, -lpthread)

SYNOPSIS
       #define _GNU_SOURCE             /* See feature_test_macros(7) */
       #include <pthread.h>

       [[deprecated]] int pthread_yield(void);

DESCRIPTION
       Note: This function is deprecated; see below.

       pthread_yield() causes the calling thread to relinquish the CPU.  The
       thread is placed at the end of the run queue for its static priority
       and another thread is scheduled to run.  For further details, see
       sched_yield(2)

RETURN VALUE
       On success, pthread_yield() returns 0; on error, it returns an error
       number.

ERRORS
       On Linux, this call always succeeds (but portable and future-proof
       applications should nevertheless handle a possible error return).

ATTRIBUTES
       For an explanation of the terms used in this section, see
       attributes(7).

       +--------------------------------------------+---------------+---------+
       |Interface                                   | Attribute     | Value   |
       +--------------------------------------------+---------------+---------+
       |pthread_yield ()                            | Thread safety | MT-Safe |
       +--------------------------------------------+---------------+---------+
VERSIONS
       On Linux, this function is implemented as a call to sched_yield(2).

STANDARDS
       None.

HISTORY
       Deprecated since glibc 2.34.  Use the standardized sched_yield(2)
       instead.

NOTES
       pthread_yield() is intended for use with real-time scheduling policies
       (i.e., SCHED_FIFO or SCHED_RR).  Use of pthread_yield() with
       nondeterministic scheduling policies such as SCHED_OTHER is unspecified
       and very likely means your application design is broken.

SEE ALSO
       sched_yield(2), pthreads(7), sched(7)

Linux man-pages 6.7               2023-10-31                  pthread_yield(3)