logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

pthread_yield - yield the processor

Attributes

       For an explanation of the terms used in this section, see attributes(7).
       ┌─────────────────────────────────────────────────────────────────────────────┬───────────────┬─────────┐
       │ InterfaceAttributeValue   │
       ├─────────────────────────────────────────────────────────────────────────────┼───────────────┼─────────┤
       │ pthread_yield()                                                             │ Thread safety │ MT-Safe │
       └─────────────────────────────────────────────────────────────────────────────┴───────────────┴─────────┘

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)

Errors

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

History

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

Library

       POSIX threads library (libpthread, -lpthread)

Name

       pthread_yield - yield the processor

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.

Return Value

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

See Also

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

Linux man-pages 6.9.1                              2024-05-02                                   pthread_yield(3)

Standards

       None.

Synopsis

#define_GNU_SOURCE             /* See feature_test_macros(7) */
       #include<pthread.h>[[deprecated]]intpthread_yield(void);

Versions

       On Linux, this function is implemented as a call to sched_yield(2).

See Also