1999-08-28 00:22:10 +00:00
|
|
|
.\" $FreeBSD$
|
1998-03-28 11:51:01 +00:00
|
|
|
.\" Copyright (c) 1998 HD Associates, Inc.
|
|
|
|
|
.\" All rights reserved.
|
|
|
|
|
.\"
|
|
|
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
|
|
|
.\" modification, are permitted provided that the following conditions
|
|
|
|
|
.\" are met:
|
|
|
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
|
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
|
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
|
|
|
.\"
|
|
|
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
|
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
|
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
|
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
|
|
|
|
|
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
|
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
|
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
|
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
|
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
|
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
|
.\" SUCH DAMAGE.
|
|
|
|
|
.\"
|
2000-12-11 15:15:20 +00:00
|
|
|
.Dd March 12, 1998
|
1998-03-28 11:51:01 +00:00
|
|
|
.Dt SCHED_YIELD 2
|
2001-07-10 13:41:46 +00:00
|
|
|
.Os
|
1998-03-28 11:51:01 +00:00
|
|
|
.Sh NAME
|
|
|
|
|
.Nm sched_yield
|
|
|
|
|
.Nd yield processor
|
2000-04-21 09:42:15 +00:00
|
|
|
.Sh LIBRARY
|
|
|
|
|
.Lb libc
|
1998-03-28 11:51:01 +00:00
|
|
|
.Sh SYNOPSIS
|
2001-10-01 16:09:29 +00:00
|
|
|
.In sched.h
|
1998-03-28 11:51:01 +00:00
|
|
|
.Ft int
|
|
|
|
|
.Fn sched_yield void
|
|
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn sched_yield
|
|
|
|
|
function forces the running process to relinquish the processor until it
|
|
|
|
|
again becomes the head of its process list. It takes no arguments.
|
2000-11-17 11:44:16 +00:00
|
|
|
.Sh RETURN VALUES
|
2001-08-09 13:32:13 +00:00
|
|
|
.Rv -std sched_yield
|
1998-03-28 11:51:01 +00:00
|
|
|
.Sh ERRORS
|
|
|
|
|
On failure
|
|
|
|
|
.Va errno
|
|
|
|
|
will be set to the corresponding value:
|
2000-05-04 13:09:25 +00:00
|
|
|
.Bl -tag -width Er
|
1998-03-28 11:51:01 +00:00
|
|
|
.It Bq Er ENOSYS
|
|
|
|
|
The system is not configured to support this functionality.
|
2000-12-29 14:08:20 +00:00
|
|
|
.El
|
1998-03-28 11:51:01 +00:00
|
|
|
.Sh STANDARDS
|
|
|
|
|
The
|
2001-07-15 07:53:42 +00:00
|
|
|
.Fn sched_yield
|
1998-03-28 11:51:01 +00:00
|
|
|
function conforms to
|
|
|
|
|
.St -p1003.1b-93 .
|
