mirror of https://github.com/mkerrisk/man-pages
pthread_attr_setschedparam.3: New page for pthread_attr_setschedparam(3) and pthread_attr_getschedparam(3)
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
parent
d71915efe6
commit
b326494cc0
|
@ -0,0 +1,104 @@
|
|||
.\" Copyright (c) 2008 Linux Foundation, written by 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_ATTR_SETSCHEDPARAM 3 2008-11-05 "Linux" "Linux Programmer's Manual"
|
||||
.SH NAME
|
||||
pthread_attr_setschedparam, pthread_attr_getschedparam \- set/get
|
||||
scheduling parameter attributes in thread attributes object
|
||||
.SH SYNOPSIS
|
||||
.nf
|
||||
.B #include <pthread.h>
|
||||
|
||||
.BI "int pthread_attr_setschedparam(pthread_attr_t *" attr ,
|
||||
.BI " const struct sched_param *" param );
|
||||
.BI "int pthread_attr_getschedparam(pthread_attr_t *" attr ,
|
||||
.BI " struct sched_param *" param );
|
||||
.sp
|
||||
Compile and link with \fI\-pthread\fP.
|
||||
.SH DESCRIPTION
|
||||
The
|
||||
.BR pthread_attr_setschedparam ()
|
||||
function sets the scheduling parameter attributes of the
|
||||
thread attributes object referred to by
|
||||
.IR thread
|
||||
to the values specified in the buffer pointed to by
|
||||
.IR param .
|
||||
These attributes determine the scheduling parameters of
|
||||
a thread created using the thread attributes object
|
||||
.IR attr .
|
||||
|
||||
The
|
||||
.BR pthread_attr_getschedparam ()
|
||||
returns the scheduling parameter attributes of the thread attributes object
|
||||
.IR attr
|
||||
in the buffer pointed to by
|
||||
.IR param .
|
||||
|
||||
Scheduling parameters are maintained in the following structure:
|
||||
|
||||
.in +4n
|
||||
.nf
|
||||
struct sched_param {
|
||||
int sched_priority; /* Scheduling priority */
|
||||
};
|
||||
.fi
|
||||
.in
|
||||
|
||||
As can be seen, only one scheduling parameter is supported
|
||||
(this is the only parameter specified by POSIX.1-2001.)
|
||||
For details of the permitted ranges for scheduling priorities
|
||||
in each scheduling policy, see
|
||||
.BR sched_setscheduler (2).
|
||||
.SH RETURN VALUE
|
||||
On success, these functions return 0;
|
||||
on error, they return a non-zero error number.
|
||||
.SH ERRORS
|
||||
POSIX.1 documents
|
||||
.B EINVAL
|
||||
and
|
||||
.B ENOTSUP
|
||||
errors for
|
||||
.BR pthread_attr_setschedparam ().
|
||||
On Linux these functions always succeed
|
||||
(but portable and future-proof applications should nevertheless
|
||||
handle a possible error return).
|
||||
.\" .SH VERSIONS
|
||||
.\" Available since glibc 2.0.
|
||||
.SH CONFORMING TO
|
||||
POSIX.1-2001.
|
||||
.\" .SH EXAMPLE
|
||||
.\" FIXME . Add (a pointer to) an example
|
||||
.SH NOTES
|
||||
See
|
||||
.BR pthread_attr_setschedpolicy (3)
|
||||
for a list of the thread scheduling policies supported on Linux.
|
||||
.SH SEE ALSO
|
||||
.BR sched_get_priority_min (2),
|
||||
.BR sched_setscheduler (2),
|
||||
.BR pthread_attr_init (3),
|
||||
.BR pthread_attr_setinheritsched (3),
|
||||
.BR pthread_attr_setschedpolicy (3),
|
||||
.BR pthread_create (3),
|
||||
.BR pthread_setschedparam (3),
|
||||
.BR pthread_setschedprio (3),
|
||||
.BR pthreads (7)
|
Loading…
Reference in New Issue