xref: /openbsd-src/lib/libpthread/man/pthread_yield.3 (revision 86f9d4cdda0e0267dccd8755ac0035525579c4a7)
1*86f9d4cdStedu.\" $OpenBSD: pthread_yield.3,v 1.5 2013/06/05 03:44:50 tedu Exp $
253ae0483Smarc.\"
353ae0483Smarc.\" PUBLIC DOMAIN: No Rights Reserved. Marco S Hyman <marc@snafu.org>
453ae0483Smarc.\"
5*86f9d4cdStedu.Dd $Mdocdate: June 5 2013 $
653ae0483Smarc.Dt PTHREAD_YIELD 3
753ae0483Smarc.Os
853ae0483Smarc.Sh NAME
953ae0483Smarc.Nm pthread_yield
1053ae0483Smarc.Nd yield control of the current thread
1153ae0483Smarc.Sh SYNOPSIS
12*86f9d4cdStedu.In pthread.h
1353ae0483Smarc.Ft void
1453ae0483Smarc.Fn pthread_yield "void"
1553ae0483Smarc.Sh DESCRIPTION
1653ae0483SmarcThe
1753ae0483Smarc.Fn pthread_yield
1853ae0483Smarcfunction resets the accumulated time slice of the current thread and then
19fc0286f9Sjmcenters the thread scheduler, which resumes execution of the next thread ready
2053ae0483Smarcto run.
21fc0286f9SjmcIf no other thread is ready to run, control returns to the current thread.
2253ae0483Smarc.Sh SEE ALSO
2353ae0483Smarc.Xr pthreads 3
2453ae0483Smarc.Sh STANDARDS
2553ae0483Smarc.Fn pthread_yield
2653ae0483Smarcis a non-portable (but quite common) extension to
277a5684e3Sjmc.St -p1003.1-2001 .
28