original/man3/pthread_yield.3

   1 .\" Copyright (c) 2009 Michael Kerrisk, <mtk.manpages@gmail.com>
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\"
  23 .TH PTHREAD_YIELD 3 2009-04-10 "Linux" "Linux Programmer's Manual"
  24 .SH NAME
  25 pthread_yield \- yield the processor
  26 .SH SYNOPSIS
  27 .nf
  28 .B #include <pthread.h>
  29
  30 .B int pthread_yield(void);
  31 .fi
  32 .sp
  33 Compile and link with \fI\-pthread\fP.
  34 .SH DESCRIPTION
  35 .BR pthread_yield ()
  36 causes the calling thread to relinquish the CPU.
  37 The thread is placed at the end of the run queue for its static
  38 priority and another thread is scheduled to run.
  39 For further details, see
  40 .BR sched_yield (2)
  41 .SH RETURN VALUE
  42 On success,
  43 .BR pthread_yield ()
  44 returns 0;
  45 on error, it returns an error number.
  46 .SH ERRORS
  47 On Linux, this call always succeeds
  48 (but portable and future-proof applications should nevertheless
  49 handle a possible error return).
  50 .SH CONFORMING TO
  51 This call is nonstandard, but present on several other systems.
  52 Use the standardized
  53 .BR sched_yield (2)
  54 instead.
  55 .\" e.g., the BSDs, Tru64, AIX, and Irix.
  56 .SH NOTES
  57 On Linux, this function is implemented as a call to
  58 .BR sched_yield (2).
  59 .SH SEE ALSO
  60 .BR sched_setscheduler (2),
  61 .BR sched_yield (2)
  62 .BR pthreads (7)