pthread_attr_setschedparam(3) — Linux manual pages

Linux manual pages	Section 3: Subroutines

Name

pthread_attr_setschedparam, pthread_attr_getschedparam — set/get scheduling parameter attributes in thread attributes object

Synopsis

#include <pthread.h>

`int pthread_attr_setschedparam(`	pthread_attr_t *`attr`,
	const struct sched_param *`param)`;

`int pthread_attr_getschedparam(`	pthread_attr_t *`attr`,
	struct sched_param *`param)`;

	Note
	Compile and link with `−pthread`.

DESCRIPTION

The pthread_attr_setschedparam() function sets the scheduling parameter attributes of the thread attributes object referred to by attr to the values specified in the buffer pointed to by param. These attributes determine the scheduling parameters of a thread created using the thread attributes object attr.

The pthread_attr_getschedparam() returns the scheduling parameter attributes of the thread attributes object attr in the buffer pointed to by param.

Scheduling parameters are maintained in the following structure:

struct sched_param {

int sched_priority;
/* Scheduling priority */

};

As can be seen, only one scheduling parameter is supported. For details of the permitted ranges for scheduling priorities in each scheduling policy, see sched_setscheduler(2).

In order for the parameter setting made by pthread_attr_setschedparam() to have effect when calling pthread_create(3), the caller must use pthread_attr_setinheritsched(3) to set the inherit-scheduler attribute of the attributes object attr to PTHREAD_EXPLICIT_SCHED.

RETURN VALUE

On success, these functions return 0; on error, they return a nonzero error number.

ERRORS

POSIX.1 documents EINVAL and ENOTSUP errors for pthread_attr_setschedparam(). On Linux these functions always succeed (but portable and future-proof applications should nevertheless handle a possible error return).

CONFORMING TO

POSIX.1-2001.

NOTES

See pthread_attr_setschedpolicy(3) for a list of the thread scheduling policies supported on Linux.

EXAMPLE

See pthread_setschedparam(3).

COLOPHON

This page is part of release 3.52 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man−pages/.

  Copyright (c) 2008 Linux Foundation, written by Michael Kerrisk
    <mtk.manpagesgmail.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

struct	sched_param {
	int	`sched_priority`;	/* Scheduling priority */
};