pthread_yield - Man Page

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

InterfaceAttributeValue
pthread_yield()Thread safetyMT-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)

Info

2023-10-31 Linux man-pages 6.06