Files
oldlinux-files/Ref-docs/POSIX/susv3/functions/pthread_condattr_getclock.html
2024-02-19 00:21:47 -05:00

150 lines
5.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css"><!-- Generated by The Open Group's rhtm tool v1.2.1 -->
<!-- Copyright (c) 2001 The Open Group, All Rights Reserved -->
<title>pthread_condattr_getclock</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="pthread_condattr_getclock"></a> <a name="tag_03_520"></a><!-- pthread_condattr_getclock -->
<!--header start-->
<center><font size="2">The Open Group Base Specifications Issue 6<br>
IEEE Std 1003.1-2001<br>
Copyright &copy; 2001 The IEEE and The Open Group, All Rights reserved.</font></center>
<!--header end-->
<hr size="2" noshade>
<h4><a name="tag_03_520_01"></a>NAME</h4>
<blockquote>pthread_condattr_getclock, pthread_condattr_setclock - get and set the clock selection condition variable attribute
(<b>ADVANCED REALTIME</b>)</blockquote>
<h4><a name="tag_03_520_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('THR CS')">THR CS</a>]</sup> <img src="../images/opt-start.gif" alt=
"[Option Start]" border="0"> #include &lt;<a href="../basedefs/pthread.h.html">pthread.h</a>&gt;<br>
<br>
int pthread_condattr_getclock(const pthread_condattr_t *restrict</tt> <i>attr</i><tt>,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; clockid_t *restrict</tt> <i>clock_id</i><tt>);<br>
int pthread_condattr_setclock(pthread_condattr_t *</tt><i>attr</i><tt>,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; clockid_t</tt> <i>clock_id</i><tt>); <img src="../images/opt-end.gif" alt="[Option End]"
border="0"></tt></code></div>
<tt><br>
</tt></blockquote>
<h4><a name="tag_03_520_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>pthread_condattr_getclock</i>() function shall obtain the value of the <i>clock</i> attribute from the attributes object
referenced by <i>attr</i>. The <i>pthread_condattr_setclock</i>() function shall set the <i>clock</i> attribute in an initialized
attributes object referenced by <i>attr</i>. If <i>pthread_condattr_setclock</i>() is called with a <i>clock_id</i> argument that
refers to a CPU-time clock, the call shall fail.</p>
<p>The <i>clock</i> attribute is the clock ID of the clock that shall be used to measure the timeout service of <a href=
"../functions/pthread_cond_timedwait.html"><i>pthread_cond_timedwait</i>()</a>. The default value of the <i>clock</i> attribute
shall refer to the system clock.</p>
</blockquote>
<h4><a name="tag_03_520_04"></a>RETURN VALUE</h4>
<blockquote>
<p>If successful, the <i>pthread_condattr_getclock</i>() function shall return zero and store the value of the clock attribute of
<i>attr</i> into the object referenced by the <i>clock_id</i> argument. Otherwise, an error number shall be returned to indicate
the error.</p>
<p>If successful, the <i>pthread_condattr_setclock</i>() function shall return zero; otherwise, an error number shall be returned
to indicate the error.</p>
</blockquote>
<h4><a name="tag_03_520_05"></a>ERRORS</h4>
<blockquote>
<p>These functions may fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The value specified by <i>attr</i> is invalid.</dd>
</dl>
<p>The <i>pthread_condattr_setclock</i>() function may fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The value specified by <i>clock_id</i> does not refer to a known clock, or is a CPU-time clock.</dd>
</dl>
<p>These functions shall not return an error code of [EINTR].</p>
</blockquote>
<hr>
<div class="box"><em>The following sections are informative.</em></div>
<h4><a name="tag_03_520_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_520_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_520_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_520_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_520_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="pthread_cond_destroy.html"><i>pthread_cond_destroy</i>()</a> , <a href=
"pthread_cond_timedwait.html"><i>pthread_cond_timedwait</i>()</a> , <a href=
"pthread_condattr_destroy.html"><i>pthread_condattr_destroy</i>()</a> , <a href=
"pthread_condattr_getpshared.html"><i>pthread_condattr_getpshared</i>()</a> ,1 <a href=
"pthread_condattr_init.html"><i>pthread_condattr_init</i>()</a> , <a href=
"pthread_condattr_setpshared.html"><i>pthread_condattr_setpshared</i>()</a> ,1 <a href=
"pthread_create.html"><i>pthread_create</i>()</a> , <a href="pthread_mutex_init.html"><i>pthread_mutex_init</i>()</a> , the Base
Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/pthread.h.html"><i>&lt;pthread.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_520_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 6. Derived from IEEE&nbsp;Std&nbsp;1003.1j-2000.</p>
</blockquote>
<div class="box"><em>End of informative text.</em></div>
<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>
<!--footer end-->
<hr size="2" noshade>
</body>
</html>