pthread_attr_set_getschedparam(3)

pthread_attr_set_getschedparam3

Thread attribute operations

Usage

#include <pthread.h>

int

pthread_attr_getschedparam(const pthread_attr_t *restrict attr, struct sched_param *restrict param);

int

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

Overview

Thread attributes are used to specify parameters to pthread_create(). One attribute object can be used in multiple calls to pthread_create(), with or without modifications between calls.

pthread_attr_getschedparam() and pthread_attr_setschedparam() get and set the scheduling parameters within the attr argument. See /usr/include/sched.h for the definition of struct, sched_param. The sched_priority field of struct, sched_param must be within the range returned by the sched_get_priority_min(2) and sched_get_priority_max(2) system calls.

Return values

If successful, these functions return 0. Otherwise, an error number is returned to indicate the error. pthread_attr_getschedparam(), on success, will copy the value of the thread's scheduling parameter attribute to the location pointed to by the second function parameter.

Errors

pthread_attr_getschedparam() will fail if:

[EINVAL]

Invalid value for attr.

pthread_attr_setschedparam() will fail if:

[EINVAL]

Invalid value for attr.

[ENOTSUP]

Invalid value for param.

Releases

100 releases since Mac OS X 10.6; the text changed 1 time.

  1. 10.6–10.12.6
  2. 10.13–26.5

Standards

pthread_attr_setschedparam(), pthread_attr_getschedparam() conform to Version 2 of the Single UNIX Specification (“SUSv2”)

From libpthread 539.100.4 in macOS 26.5. Parsed by carta from the page's mdoc source.