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