xref: /illumos-gate/usr/src/man/man3c/pthread_condattr_getclock.3c (revision bc1f688b4872ace323eaddbb1a6365d054e7bf56)

Sun Microsystems, Inc. gratefully acknowledges The Open Group for
permission to reproduce portions of its copyrighted documentation.
Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.

The Institute of Electrical and Electronics Engineers and The Open
Group, have given us permission to reprint portions of their
documentation.

In the following statement, the phrase ``this text'' refers to portions
of the system documentation.

Portions of this text are reprinted and reproduced in electronic form
in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
Standard for Information Technology -- Portable Operating System
Interface (POSIX), The Open Group Base Specifications Issue 6,
Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
Engineers, Inc and The Open Group. In the event of any discrepancy
between these versions and the original IEEE and The Open Group
Standard, the original IEEE and The Open Group Standard is the referee
document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html.

This notice shall appear on any product containing this material.

The contents of this file are subject to the terms of the
Common Development and Distribution License (the "License").
You may not use this file except in compliance with the License.

You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
or http://www.opensolaris.org/os/licensing.
See the License for the specific language governing permissions
and limitations under the License.

When distributing Covered Code, include this CDDL HEADER in each
file and include the License file at usr/src/OPENSOLARIS.LICENSE.
If applicable, add the following below this CDDL HEADER, with the
fields enclosed by brackets "[]" replaced with your own identifying
information: Portions Copyright [yyyy] [name of copyright owner]


Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved.
Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.

PTHREAD_CONDATTR_GETCLOCK 3C "Jan 30, 2004"
NAME
pthread_condattr_getclock, pthread_condattr_setclock - get and set the clock selection condition variable attribute
SYNOPSIS

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

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 obtains the value of the clock attribute from the attributes object referenced by attr. The pthread_condattr_setclock() function sets 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 fails.

The clock attribute is the clock ID of the clock that is used to measure the timeout service of pthread_cond_timedwait(3C). The default value of the clock attribute refers to the system clock.

RETURN VALUES

Upon successful completion, the pthread_condattr_getclock() function returns 0 and stores the value of the clock attribute of attr into the object referenced by the clock_id argument. Otherwise, an error number is returned to indicate the error.

Upon successful completion, the pthread_condattr_setclock() function returns 0. Otherwise, an error number is 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.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level MT-Safe
SEE ALSO

pthread_cond_init(3C), pthread_cond_timedwait(3C), pthread_condattr_destroy(3C), pthread_condattr_getpshared(3C), pthread_create(3C), pthread_mutex_init(3C), attributes(5), standards(5)