2009-04-15 15:47:24 +00:00
|
|
|
.\" Copyright (c) 2009 Michael Kerrisk, <mtk.manpages@gmail.com>
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
|
|
|
.\"
|
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
|
|
|
.\"
|
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.TH PTHREAD_YIELD 3 2009-04-10 "Linux" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
|
|
|
pthread_yield \- yield the processor
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <pthread.h>
|
|
|
|
|
|
|
|
.B int pthread_yield(void);
|
|
|
|
.fi
|
|
|
|
.sp
|
|
|
|
Compile and link with \fI\-pthread\fP.
|
|
|
|
.SH DESCRIPTION
|
|
|
|
.BR pthread_yield ()
|
|
|
|
causes the calling thread to relinquish the CPU.
|
|
|
|
The thread is placed at the end of the run queue for its static
|
|
|
|
priority and another thread is scheduled to run.
|
|
|
|
For further details, see
|
|
|
|
.BR sched_yield (2)
|
|
|
|
.SH RETURN VALUE
|
|
|
|
On success,
|
|
|
|
.BR pthread_yield ()
|
|
|
|
returns 0;
|
|
|
|
on error, it returns an error number.
|
|
|
|
.SH ERRORS
|
|
|
|
On Linux, this call always succeeds
|
|
|
|
(but portable and future-proof applications should nevertheless
|
|
|
|
handle a possible error return).
|
|
|
|
.SH CONFORMING TO
|
accept.2, execve.2, futimesat.2, getresuid.2, getrlimit.2, madvise.2, mq_getsetattr.2, msgctl.2, nice.2, open.2, poll.2, setresuid.2, shmctl.2, sigaction.2, times.2, utimensat.2, __setfpucw.3, atoi.3, endian.3, err.3, euidaccess.3, fenv.3, fopencookie.3, fpurge.3, getgrouplist.3, getutmp.3, j0.3, lgamma.3, netlink.3, pthread_attr_init.3, pthread_attr_setaffinity_np.3, pthread_cleanup_push_defer_np.3, pthread_getattr_np.3, pthread_kill_other_threads_np.3, pthread_setaffinity_np.3, pthread_tryjoin_np.3, pthread_yield.3, random_r.3, readdir.3, rtnetlink.3, scanf.3, setenv.3, significand.3, sigsetops.3, strerror.3, strstr.3, sysv_signal.3, termios.3, timegm.3, unlocked_stdio.3, y0.3, locale.5, bootparam.7, feature_test_macros.7, ip.7, locale.7, pthreads.7, rtld-audit.7, nscd.8: Global fix: s/non-standard/nonstandard/
The tendency in English, as prescribed in style guides like
Chicago MoS, is towards removing hyphens after prefixes
like "non-" etc.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-01-16 16:37:52 +00:00
|
|
|
This call is nonstandard, but present on several other systems.
|
2009-04-15 15:47:24 +00:00
|
|
|
Use the standardized
|
|
|
|
.BR sched_yield (2)
|
|
|
|
instead.
|
|
|
|
.\" e.g., the BSDs, Tru64, AIX, and Irix.
|
|
|
|
.SH NOTES
|
|
|
|
On Linux, this function is implemented as a call to
|
|
|
|
.BR sched_yield (2).
|
|
|
|
.SH SEE ALSO
|
|
|
|
.BR sched_setscheduler (2),
|
|
|
|
.BR sched_yield (2)
|
|
|
|
.BR pthreads (7)
|