PTHREAD_CONDATTR(3)

PTHREAD_CONDATTR(3) | Library Functions Manual | PTHREAD_CONDATTR(3)

# NAME

pthread_condattr_init, pthread_condattr_getpshared, pthread_condattr_setpshared, pthread_condattr_getclock, pthread_condattr_setclock — condition attribute operations

# LIBRARY

POSIX Threads Library (libpthread, -lpthread)

# SYNOPSIS

#include <pthread.h>
int
pthread_condattr_init(pthread_condattr_t *attr);
int
pthread_condattr_getclock(const pthread_condattr_t *__restrict attr, clockid_t * __restrict clock_id);
int
pthread_condattr_setclock(pthread_condattr_t *attr, clockid_t clock);
int
pthread_condattr_destroy(pthread_condattr_t *attr);
int
pthread_condattr_getpshared(const pthread_condattr_t * __restrict attr, int * __restrict pshared);
int
pshared_condattr_setpshared(pthread_condattr_t *attr, int pshared);

# DESCRIPTION

Condition attribute objects are used to specify parameters to the pthread_cond_init(3) function. The pthread_condattr_init() function initializes a condition attribute object with the default attributes and the pthread_condattr_destroy() function destroys a condition attribute object. The pthread_condattr_getclock() function shall obtain the value of the clock attributes object referenced by attr. The pthread_condattr_setclock() function sets the system clock to be used for time comparisons to the one specified in clock. Valid clock values are `CLOCK_MONOTONIC` and `CLOCK_REALTIME` (the default). The pthread_condattr_getpshared() function shall obtain the value of the process-shared attribute from the attributes object referenced by attr. The pthread_condattr_setpshared() function shall set the process-shared attribute in an initialized attributes object referenced by attr.

# RETURN VALUES

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

# ERRORS

No errors are defined for pthread_condattr_init().
The pthread_condattr_destroy() function may fail if:

[`EINVAL`]
  The value specified by attr is invalid.

The pthread_condattr_getclock() and pthread_condattr_setclock() may fail if:

[`EINVAL`]
  The value specified by attr is invalid.

The pthread_condattr_getpshared() and pthread_condattr_setpshared() may fail if:

[`EINVAL`]
  The value specified by attr is invalid.

# SEE ALSO

pthread_cond_init(3)

# STANDARDS

Both functions conform to IEEE Std 1003.1-2001 (“POSIX.1”).

# BUGS

The pthread_condattr_getpshared() and pthread_condattr_setpshared() functions are hidden by default since only thread shared attributes are supported.

March 28, 2017 | NetBSD 8.3