pthread_yield(3) — Linux manual page
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)
COLOPHON
This page is part of the man-pages (Linux kernel and C library
user-space interface documentation) project. Information about
the project can be found at
⟨https://www.kernel.org/doc/man-pages/⟩. If you have a bug report
for this manual page, see
⟨https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/tree/CONTRIBUTING⟩.
This page was obtained from the tarball man-pages-6.9.1.tar.gz
fetched from
⟨https://mirrors.edge.kernel.org/pub/linux/docs/man-pages/⟩ on
2024-06-26. If you discover any rendering problems in this HTML
version of the page, or you believe there is a better or more up-
to-date source for the page, or you have corrections or
improvements to the information in this COLOPHON (which is not
part of the original manual page), send a mail to
man-pages@man7.org