xref: /freebsd/share/man/man3/pthread_yield.3 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
1.\" $OpenBSD: pthread_yield.3,v 1.3 2004/01/25 14:48:32 jmc Exp $
2.\"
3.\" PUBLIC DOMAIN: No Rights Reserved. Marco S Hyman <marc@snafu.org>
4.\"
5.Dd September 18, 2006
6.Dt PTHREAD_YIELD 3
7.Os
8.Sh NAME
9.Nm pthread_yield
10.Nd yield control of the current thread
11.Sh LIBRARY
12.Lb libpthread
13.Sh SYNOPSIS
14.In pthread.h
15.Ft void
16.Fn pthread_yield void
17.Sh DESCRIPTION
18The
19.Fn pthread_yield
20forces the running thread to relinquish the processor until it again
21becomes the head of its thread list.
22.Sh SEE ALSO
23.Xr sched_yield 2
24.Sh STANDARDS
25The
26.Fn pthread_yield
27is a non-portable (but quite common) extension to
28.St -p1003.1-2001 .
29