carta
pthread_attr_set_getinheritsched(3)

pthread_attr_set_getinheritsched3

Thread attribute operations

Usage

int

int

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.

One of the thread attributes of interest is the "inheritsched" attribute. This attribute controls the scheduling policy and related attributes of the newly created thread. The values of the "inheritsched" attribute can be either PTHREAD_INHERIT_SCHED or PTHREAD_EXPLICIT_SCHED.

PTHREAD_INHERIT_SCHED

Indicates that the newly created thread should inherit all it's scheduling related attributes from it's creating thread. It ignores the values of the relevant attributes within the attr argument.

PTHREAD_EXPLICIT_SCHED

Indicates that the newly created thread should set it's scheduling related attributes based on attr argument.

The pthread_attr_setinheritsched() functions set the "inheritsched" attribute within the attr argument to the desired value.

The pthread_attr_getinheritsched() functions copy the value of the "inheritsched" attribute to the location pointed to by the second function parameter.

Return values

If successful, these functions return 0. Otherwise, an error number is returned to indicate the error.

Errors

pthread_attr_getinheritsched() will fail if:

[EINVAL]

Invalid value for attr.

pthread_attr_setinheritsched() will fail if:

[EINVAL]

Invalid value for attr.

History

  • macOS 26.5 to macOS 10.13: the text shown here
  • macOS 10.12.6 to Mac OS X 10.6

Bugs

The "inheritsched" attribute has no effect on Darwin. It is provided for compatibility only.

Standards

pthread_attr_setinheritsched(), pthread_attr_getinheritsched() 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.