xref: /freebsd/share/man/man3/pthread_yield.3 (revision cddbc3b40812213ff00041f79174cac0be360a2a)
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.\" $FreeBSD$
6.\"
7.Dd September 18, 2006
8.Dt PTHREAD_YIELD 3
9.Os
10.Sh NAME
11.Nm pthread_yield
12.Nd yield control of the current thread
13.Sh LIBRARY
14.Lb libpthread
15.Sh SYNOPSIS
16.In pthread.h
17.Ft void
18.Fn pthread_yield void
19.Sh DESCRIPTION
20The
21.Fn pthread_yield
22forces the running thread to relinquish the processor until it again
23becomes the head of its thread list.
24.Sh SEE ALSO
25.Xr sched_yield 2
26.Sh STANDARDS
27The
28.Fn pthread_yield
29is a non-portable (but quite common) extension to
30.St -p1003.1-2001 .
31