usr/src/man/man3c/pthread_condattr_getclock.3c

   1 '\" te
   2 .\" Copyright (c) 2001, the Institute of Electrical and Electronics Engineers, Inc. and The Open Group. All Rights Reserved.
   3 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" 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
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\" 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 Sun OS 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.
   7 .\"  This notice shall appear on any product containing this material.
   8 .\" 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.
   9 .\" 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.
  10 .\" 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]
  11 .TH PTHREAD_CONDATTR_GETCLOCK 3C "Jan 30, 2004"
  12 .SH NAME
  13 pthread_condattr_getclock, pthread_condattr_setclock \- get and set the clock
  14 selection condition variable attribute
  15 .SH SYNOPSIS
  16 .LP
  17 .nf
  18 cc \fB-mt\fR [ \fIflag\fR... ] \fIfile\fR... [ \fIlibrary\fR... ]
  19 #include <pthread.h>
  20
  21 \fBint\fR \fBpthread_condattr_getclock\fR(
  22      \fBconst pthread_condattr_t *restrict\fR \fIattr\fR,
  23      \fBclockid_t *restrict\fR \fIclock_id\fR);
  24 .fi
  25
  26 .LP
  27 .nf
  28 \fBint\fR \fBpthread_condattr_setclock\fR(\fBpthread_condattr_t *\fR\fIattr\fR
  29       \fBclockid_t\fR \fIclock_id\fR);
  30 .fi
  31
  32 .SH DESCRIPTION
  33 .sp
  34 .LP
  35 The \fBpthread_condattr_getclock()\fR function obtains the value of the clock
  36 attribute from the attributes object referenced by \fIattr\fR. The
  37 \fBpthread_condattr_setclock()\fR function sets the clock attribute in an
  38 initialized attributes object referenced by \fIattr\fR. If
  39 \fBpthread_condattr_setclock()\fR is called with a \fIclock_id\fR argument that
  40 refers to a CPU-time clock, the call fails.
  41 .sp
  42 .LP
  43 The clock attribute is the clock ID of the clock that is used to measure the
  44 timeout service of \fBpthread_cond_timedwait\fR(3C). The default value of the
  45 clock attribute refers to the system clock.
  46 .SH RETURN VALUES
  47 .sp
  48 .LP
  49 Upon successful completion, the \fBpthread_condattr_getclock()\fR function
  50 returns 0 and stores the value of the clock attribute of \fIattr\fR into the
  51 object referenced by the \fIclock_id\fR argument. Otherwise, an error number is
  52 returned to indicate the error.
  53 .sp
  54 .LP
  55 Upon successful completion, the \fBpthread_condattr_setclock()\fR function
  56 returns 0. Otherwise, an error number is returned to indicate the error.
  57 .SH ERRORS
  58 .sp
  59 .LP
  60 These functions may fail if:
  61 .sp
  62 .ne 2
  63 .na
  64 \fB\fBEINVAL\fR\fR
  65 .ad
  66 .RS 10n
  67 The value specified by \fIattr\fR is invalid.
  68 .RE
  69
  70 .sp
  71 .LP
  72 The \fBpthread_condattr_setclock()\fR function may fail if:
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBEINVAL\fR\fR
  77 .ad
  78 .RS 10n
  79 The value specified by \fIclock_id\fR does not refer to a known clock, or is a
  80 CPU-time clock.
  81 .RE
  82
  83 .SH ATTRIBUTES
  84 .sp
  85 .LP
  86 See \fBattributes\fR(5) for descriptions of the following attributes:
  87 .sp
  88
  89 .sp
  90 .TS
  91 box;
  92 c | c
  93 l | l .
  94 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  95 _
  96 Interface Stability     Standard
  97 _
  98 MT-Level        MT-Safe
  99 .TE
 100
 101 .SH SEE ALSO
 102 .sp
 103 .LP
 104 \fBpthread_cond_init\fR(3C), \fBpthread_cond_timedwait\fR(3C),
 105 \fBpthread_condattr_destroy\fR(3C), \fBpthread_condattr_getpshared\fR(3C),
 106 \fBpthread_create\fR(3C), \fBpthread_mutex_init\fR(3C), \fBattributes\fR(5),
 107 \fBstandards\fR(5)