Content-type: text/html Man page of pthread_getschedparam

pthread_getschedparam

Section: Standard C Library Functions (3C)
Updated: 23 Nov 2005
Index Return to Main Contents
 

NAME

pthread_getschedparam, pthread_setschedparam - access dynamic thread scheduling parameters  

SYNOPSIS

cc -mt [ flag... ] file... -lpthread [ library... ]
#include <pthread.h>

int pthread_getschedparam(pthread_t thread, int *restrict policy, struct sched_param *restrict param);

int pthread_setschedparam(pthread_t thread, int policy, const struct sched_param *param);  

DESCRIPTION

The pthread_getschedparam() and pthread_setschedparam() functions allow the scheduling policy and scheduling parameters of individual threads within a multithreaded process to be retrieved and set. Supported policies are SCHED_FIFO, SCHED_RR, and SCHED_OTHER. See pthreads(5). For SCHED_FIFO, SCHED_RR, and SCHED_OTHER, the affected scheduling parameter is the sched_priority member of the sched_param structure.

The pthread_getschedparam() function retrieves the scheduling policy and scheduling parameters for the thread whose thread ID is given by thread and stores those values in policy and param, respectively. The priority value returned from pthread_getschedparam() is the value specified by the most recent pthread_setschedparam() or pthread_create() call affecting the target thread, and reflects any temporary adjustments to its priority as a result of any priority inheritance or ceiling functions. The pthread_setschedparam() function sets the scheduling policy and associated scheduling parameters for the thread whose thread ID is given by thread to the policy and associated parameters provided in policy and param, respectively.

If the pthread_setschedparam() function fails, no scheduling parameters will be changed for the target thread.  

RETURN VALUES

If successful, the pthread_getschedparam() and pthread_setschedparam() functions return 0. Otherwise, an error number is returned to indicate the error.  

ERRORS

The pthread_getschedparam() function may fail if:

ESRCH The value specified by thread does not refer to a existing thread.

The pthread_setschedparam() function may fail if:

EINVAL The value specified by policy or one of the scheduling parameters associated with the scheduling policy policy is invalid.

EPERM The caller does not have the appropriate permission to set either the scheduling parameters or the scheduling policy of the specified thread.

ESRCH The value specified by thread does not refer to a existing thread.

 

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
Interface StabilityStandard
MT-LevelMT-Safe

 

SEE ALSO

pthread_attr_init(3C), sched_getparam(3RT), sched_setparam(3RT), sched_getscheduler(3RT), sched_setscheduler(3RT), attributes(5), pthreads(5), standards(5)


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUES
ERRORS
ATTRIBUTES
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 02:37:18 GMT, October 02, 2010