xref: /openbsd-src/lib/libc/sys/sched_yield.2 (revision 1e4a47c40d3555c32d9f1fda477c5c513936ad66)
1.\"	$OpenBSD: sched_yield.2,v 1.1 2014/11/14 00:24:28 guenther Exp $
2.\"
3.\" Copyright (c) 2014 Philip Guenther <guenther@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: November 14 2014 $
18.Dt SCHED_YIELD 2
19.Os
20.Sh NAME
21.Nm sched_yield
22.Nd yield the processor
23.Sh SYNOPSIS
24.In sched.h
25.Ft int
26.Fn sched_yield void
27.Sh DESCRIPTION
28The
29.Fn sched_yield
30function makes the current thread yield the processor and be put at
31the end of its run queue without altering its priority.
32.Sh RETURN VALUES
33.Rv -std
34.Sh STANDARDS
35The
36.Fn sched_yield
37function conforms to
38.St -p1003.1-2008 .
39.Sh HISTORY
40The
41.Fn sched_yield
42system call appeared in
43.Ox 4.2 .
44.Sh CAVEATS
45The effect of
46.Fn sched_yield
47is only precisely defined for real-time scheduling classes,
48none of which are currently supported by
49.Ox .
50