[thirdparty/man-pages.git] / man3 / pthread_yield.3

.\" Copyright (c) 2009 Michael Kerrisk, <mtk.manpages@gmail.com>
.\"
.\" %%%LICENSE_START(VERBATIM)
.\" 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.
.\" %%%LICENSE_END
.\"
.TH PTHREAD_YIELD 3 2017-11-26 "Linux" "Linux Programmer's Manual"
.SH NAME
pthread_yield \- yield the processor
.SH SYNOPSIS
.nf
.BR "#define _GNU_SOURCE" "             /* See feature_test_macros(7) */"
.B #include <pthread.h>
.PP
.B int pthread_yield(void);
.fi
.PP
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 ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lb lb lb
l l l.
Interface	Attribute	Value
T{
.BR pthread_yield ()
T}	Thread safety	MT-Safe
.TE
.SH CONFORMING TO
This call is nonstandard, but present on several other systems.
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).
.PP
.BR pthread_yield ()
is intended for use with real-time scheduling policies (i.e.,
.BR SCHED_FIFO
or
.BR SCHED_RR ).
Use of
.BR pthread_yield ()
with nondeterministic scheduling policies such as
.BR SCHED_OTHER
is unspecified and very likely means your application design is broken.
.SH SEE ALSO
.BR sched_yield (2),
.\" FIXME . .BR pthread_cond_wait (3),
.BR pthreads (7),
.BR sched (7)
Commit	Line	Data
	1	.\" Copyright (c) 2009 Michael Kerrisk, <mtk.manpages@gmail.com>
	2	.\"
	3	.\" %%%LICENSE_START(VERBATIM)
	4	.\" Permission is granted to make and distribute verbatim copies of this
	5	.\" manual provided the copyright notice and this permission notice are
	6	.\" preserved on all copies.
	7	.\"
	8	.\" Permission is granted to copy and distribute modified versions of this
	9	.\" manual under the conditions for verbatim copying, provided that the
	10	.\" entire resulting derived work is distributed under the terms of a
	11	.\" permission notice identical to this one.
	12	.\"
	13	.\" Since the Linux kernel and libraries are constantly changing, this
	14	.\" manual page may be incorrect or out-of-date. The author(s) assume no
	15	.\" responsibility for errors or omissions, or for damages resulting from
	16	.\" the use of the information contained herein. The author(s) may not
	17	.\" have taken the same level of care in the production of this manual,
	18	.\" which is licensed free of charge, as they might when working
	19	.\" professionally.
	20	.\"
	21	.\" Formatted or processed versions of this manual, if unaccompanied by
	22	.\" the source, must acknowledge the copyright and authors of this work.
	23	.\" %%%LICENSE_END
	24	.\"
	25	.TH PTHREAD_YIELD 3 2017-11-26 "Linux" "Linux Programmer's Manual"
	26	.SH NAME
	27	pthread_yield \- yield the processor
	28	.SH SYNOPSIS
	29	.nf
	30	.BR "#define _GNU_SOURCE" " /* See feature_test_macros(7) */"
	31	.B #include <pthread.h>
	32	.PP
	33	.B int pthread_yield(void);
	34	.fi
	35	.PP
	36	Compile and link with \fI\-pthread\fP.
	37	.SH DESCRIPTION
	38	.BR pthread_yield ()
	39	causes the calling thread to relinquish the CPU.
	40	The thread is placed at the end of the run queue for its static
	41	priority and another thread is scheduled to run.
	42	For further details, see
	43	.BR sched_yield (2)
	44	.SH RETURN VALUE
	45	On success,
	46	.BR pthread_yield ()
	47	returns 0;
	48	on error, it returns an error number.
	49	.SH ERRORS
	50	On Linux, this call always succeeds
	51	(but portable and future-proof applications should nevertheless
	52	handle a possible error return).
	53	.SH ATTRIBUTES
	54	For an explanation of the terms used in this section, see
	55	.BR attributes (7).
	56	.TS
	57	allbox;
	58	lb lb lb
	59	l l l.
	60	Interface Attribute Value
	61	T{
	62	.BR pthread_yield ()
	63	T} Thread safety MT-Safe
	64	.TE
	65	.SH CONFORMING TO
	66	This call is nonstandard, but present on several other systems.
	67	Use the standardized
	68	.BR sched_yield (2)
	69	instead.
	70	.\" e.g., the BSDs, Tru64, AIX, and Irix.
	71	.SH NOTES
	72	On Linux, this function is implemented as a call to
	73	.BR sched_yield (2).
	74	.PP
	75	.BR pthread_yield ()
	76	is intended for use with real-time scheduling policies (i.e.,
	77	.BR SCHED_FIFO
	78	or
	79	.BR SCHED_RR ).
	80	Use of
	81	.BR pthread_yield ()
	82	with nondeterministic scheduling policies such as
	83	.BR SCHED_OTHER
	84	is unspecified and very likely means your application design is broken.
	85	.SH SEE ALSO
	86	.BR sched_yield (2),
	87	.\" FIXME . .BR pthread_cond_wait (3),
	88	.BR pthreads (7),
	89	.BR sched (7)