NAME
pthread_condattr_getclock
pthread_condattr_setclock —
get and set the clock selection condition variable
attribute (ADVANCED REALTIME)
SYNOPSIS
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_id);
DESCRIPTION
The pthread_condattr_getclock () function
shall obtain the value of the clock attribute from the
attributes object referenced by attr. The
pthread_condattr_setclock () function shall set the
clock attribute in an initialized attributes object
referenced by attr. If
pthread_condattr_setclock () is called with a
clock_id argument that refers to a CPU-time clock, the
call shall fail.
The clock attribute is the clock ID of the clock that shall be used to measure the timeout service of pthread_cond_timedwait(3). The default value of the clock attribute shall refer to the system clock.
RETURN VALUE
If successful, the
pthread_condattr_getclock () function shall return
zero and store the value of the clock attribute of attr
into the object referenced by the clock_id argument.
Otherwise, an error number shall be returned to indicate the error.
If successful, the pthread_condattr_setclock () function shall return zero; otherwise, an error number shall be returned to indicate the error.
ERRORS
These functions may fail if:
- [EINVAL]
- The value specified by attr is invalid.
The pthread_condattr_setclock () function may fail if:
- [EINVAL]
- The value specified by clock_id does not refer to a known clock, or is a CPU-time clock.
These functions shall not return an error code of [EINTR].
EXAMPLES
None.
APPLICATION USAGE
None.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
pthread_cond_destroy(3) , pthread_cond_timedwait(3) , pthread_condattr_destroy(3) , pthread_condattr_getpshared(3) ,1 pthread_condattr_init(3) , pthread_condattr_setpshared(3) ,1 pthread_create(3) , pthread_mutex_init(3) , the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), <pthread.h>
CHANGE HISTORY
First released in Issue 6. Derived from IEEE Std 1003.1j-2000.
End of informative text. footer end