xref: /dragonfly/lib/libpthread/pthread_yield.3 (revision c9c5aa9e)
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: src/share/man/man3/pthread_yield.3,v 1.2 2007/10/22 10:08:01 ru Exp $
6.\"
7.Dd December 16, 2020
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.In pthread_np.h
20.Ft void
21.Fn pthread_yield_np void
22.Sh DESCRIPTION
23The
24.Fn pthread_yield
25forces the running thread to relinquish the processor until it again
26becomes the head of its thread list.
27.Sh SEE ALSO
28.Xr sched_yield 2
29.Sh STANDARDS
30The
31.Fn pthread_yield
32is a non-portable (but quite common) extension to
33.St -p1003.1-2001 .
34