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