NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | ERRORS | CONFORMING TO | NOTES | SEE ALSO | COLOPHON

The Linux Programming Interface

PTHREAD_YIELD(3)              Linux Programmer's Manual              PTHREAD_YIELD(3)

NAME         top

       pthread_yield - yield the processor

SYNOPSIS         top

       #include <pthread.h>

       int pthread_yield(void);

       Compile and link with -pthread.

DESCRIPTION         top

       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         top

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

ERRORS         top

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

CONFORMING TO         top

       This call is nonstandard, but present on several other systems.  Use the
       standardized sched_yield(2) instead.

NOTES         top

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

SEE ALSO         top

       sched_setscheduler(2), sched_yield(2) pthreads(7)

COLOPHON         top

       This page is part of release 3.32 of the Linux man-pages project.  A
       description of the project, and information about reporting bugs, can be found
       at http://www.kernel.org/doc/man-pages/.

Linux                                 2009-04-10                     PTHREAD_YIELD(3)

HTML rendering created 2010-12-03 by Michael Kerrisk, author of The Linux Programming Interface