xref: /titanic_50/usr/src/man/man3c/thrd_yield.3c (revision dcdfe824b3dff2df12578b936adf1daf000aa129)
1*dcdfe824SRobert Mustacchi.\"
2*dcdfe824SRobert Mustacchi.\" This file and its contents are supplied under the terms of the
3*dcdfe824SRobert Mustacchi.\" Common Development and Distribution License ("CDDL"), version 1.0.
4*dcdfe824SRobert Mustacchi.\" You may only use this file in accordance with the terms of version
5*dcdfe824SRobert Mustacchi.\" 1.0 of the CDDL.
6*dcdfe824SRobert Mustacchi.\"
7*dcdfe824SRobert Mustacchi.\" A full copy of the text of the CDDL should have accompanied this
8*dcdfe824SRobert Mustacchi.\" source.  A copy of the CDDL is also available via the Internet at
9*dcdfe824SRobert Mustacchi.\" http://www.illumos.org/license/CDDL.
10*dcdfe824SRobert Mustacchi.\"
11*dcdfe824SRobert Mustacchi.\"
12*dcdfe824SRobert Mustacchi.\" Copyright 2016 Joyent, Inc.
13*dcdfe824SRobert Mustacchi.\"
14*dcdfe824SRobert Mustacchi.Dd "Jan 11, 2015"
15*dcdfe824SRobert Mustacchi.Dt THRD_YIELD 3C
16*dcdfe824SRobert Mustacchi.Os
17*dcdfe824SRobert Mustacchi.Sh NAME
18*dcdfe824SRobert Mustacchi.Nm thrd_yield
19*dcdfe824SRobert Mustacchi.Nd yield the CPU to another thread
20*dcdfe824SRobert Mustacchi.Sh SYNOPSIS
21*dcdfe824SRobert Mustacchi.In threads.h
22*dcdfe824SRobert Mustacchi.Ft void
23*dcdfe824SRobert Mustacchi.Fo thrd_yield
24*dcdfe824SRobert Mustacchi.Fa void
25*dcdfe824SRobert Mustacchi.Fc
26*dcdfe824SRobert Mustacchi.Sh DESCRIPTION
27*dcdfe824SRobert MustacchiThe
28*dcdfe824SRobert Mustacchi.Fn thrd_yield
29*dcdfe824SRobert Mustacchifunction causes the current thread to yield the CPU and allow other
30*dcdfe824SRobert Mustacchithreads with the same or greater priority to run.
31*dcdfe824SRobert Mustacchi.Sh INTERFACE STABILITY
32*dcdfe824SRobert Mustacchi.Sy Standard
33*dcdfe824SRobert Mustacchi.Sh MT-Level
34*dcdfe824SRobert Mustacchi.Sy MT-Safe
35*dcdfe824SRobert Mustacchi.Sh SEE ALSO
36*dcdfe824SRobert Mustacchi.Xr yield 2 ,
37*dcdfe824SRobert Mustacchi.Xr attributes 5 ,
38*dcdfe824SRobert Mustacchi.Xr threads 5
39