usr/src/man/man3c/thr_yield.3c

   1 '\" te
   2 .\"  Copyright (c) 1998 Sun Microsystems, Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH THR_YIELD 3C "May 12, 1998"
   7 .SH NAME
   8 thr_yield \- yield to another thread
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 cc -mt [ \fIflag\fR... ] \fIfile\fR...[ \fIlibrary\fR... ]
  13 #include <thread.h>
  14
  15 \fBvoid\fR \fBthr_yield\fR(\fBvoid\fR\fI\fR);
  16 .fi
  17
  18 .SH DESCRIPTION
  19 .sp
  20 .LP
  21 The \fBthr_yield()\fR function causes the current thread to yield its execution
  22 in favor of another thread with the same or greater priority.
  23 .SH RETURN VALUES
  24 .sp
  25 .LP
  26 The \fBthr_yield()\fR function returns nothing and does not set \fBerrno\fR.
  27 .SH ATTRIBUTES
  28 .sp
  29 .LP
  30 See \fBattributes\fR(5) for descriptions of the following attributes:
  31 .sp
  32
  33 .sp
  34 .TS
  35 box;
  36 c | c
  37 l | l .
  38 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  39 _
  40 MT-Level        MT-Safe
  41 .TE
  42
  43 .SH SEE ALSO
  44 .sp
  45 .LP
  46 \fBthr_setprio\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)