lib/libcr/sys/sched_yield.2

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