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