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

154 lines
5.6 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_attr_getscope</title>
</head>
<body bgcolor="white">
<script type="text/javascript" language="JavaScript" src="../jscript/codes.js">
</script>
<basefont size="3"> <a name="pthread_attr_getscope"></a> <a name="tag_03_493"></a><!-- pthread_attr_getscope -->
<!--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_493_01"></a>NAME</h4>
<blockquote>pthread_attr_getscope, pthread_attr_setscope - get and set the contentionscope attribute (<b>REALTIME
THREADS</b>)</blockquote>
<h4><a name="tag_03_493_02"></a>SYNOPSIS</h4>
<blockquote class="synopsis">
<div class="box"><code><tt><sup>[<a href="javascript:open_code('THR TPS')">THR TPS</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_attr_getscope(const pthread_attr_t *restrict</tt> <i>attr</i><tt>,<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; int *restrict</tt> <i>contentionscope</i><tt>);<br>
int pthread_attr_setscope(pthread_attr_t *</tt><i>attr</i><tt>, int</tt> <i>contentionscope</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_493_03"></a>DESCRIPTION</h4>
<blockquote>
<p>The <i>pthread_attr_getscope</i>() and <i>pthread_attr_setscope</i>() functions, respectively, shall get and set the
<i>contentionscope</i> attribute in the <i>attr</i> object.</p>
<p>The <i>contentionscope</i> attribute may have the values PTHREAD_SCOPE_SYSTEM, signifying system scheduling contention scope, or
PTHREAD_SCOPE_PROCESS, signifying process scheduling contention scope. The symbols PTHREAD_SCOPE_SYSTEM and PTHREAD_SCOPE_PROCESS
are defined in the <a href="../basedefs/pthread.h.html"><i>&lt;pthread.h&gt;</i></a> header.</p>
</blockquote>
<h4><a name="tag_03_493_04"></a>RETURN VALUE</h4>
<blockquote>
<p>If successful, the <i>pthread_attr_getscope</i>() and <i>pthread_attr_setscope</i>() functions shall return zero; otherwise, an
error number shall be returned to indicate the error.</p>
</blockquote>
<h4><a name="tag_03_493_05"></a>ERRORS</h4>
<blockquote>
<p>The <i>pthread_attr_setscope</i>() function may fail if:</p>
<dl compact>
<dt>[EINVAL]</dt>
<dd>The value of <i>contentionscope</i> is not valid.</dd>
<dt>[ENOTSUP]</dt>
<dd>An attempt was made to set the attribute to an unsupported value.</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_493_06"></a>EXAMPLES</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_493_07"></a>APPLICATION USAGE</h4>
<blockquote>
<p>After these attributes have been set, a thread can be created with the specified attributes using <a href=
"../functions/pthread_create.html"><i>pthread_create</i>()</a>. Using these routines does not affect the current running
thread.</p>
</blockquote>
<h4><a name="tag_03_493_08"></a>RATIONALE</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_493_09"></a>FUTURE DIRECTIONS</h4>
<blockquote>
<p>None.</p>
</blockquote>
<h4><a name="tag_03_493_10"></a>SEE ALSO</h4>
<blockquote>
<p><a href="pthread_attr_destroy.html"><i>pthread_attr_destroy</i>()</a> , <a href=
"pthread_attr_getinheritsched.html"><i>pthread_attr_getinheritsched</i>()</a> , <a href=
"pthread_attr_getschedpolicy.html"><i>pthread_attr_getschedpolicy</i>()</a> , <a href=
"pthread_attr_getschedparam.html"><i>pthread_attr_getschedparam</i>()</a> , <a href=
"pthread_create.html"><i>pthread_create</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>, <a href="../basedefs/sched.h.html"><i>&lt;sched.h&gt;</i></a></p>
</blockquote>
<h4><a name="tag_03_493_11"></a>CHANGE HISTORY</h4>
<blockquote>
<p>First released in Issue 5. Included for alignment with the POSIX Threads Extension.</p>
<p>Marked as part of the Realtime Threads Feature Group.</p>
</blockquote>
<h4><a name="tag_03_493_12"></a>Issue 6</h4>
<blockquote>
<p>The <i>pthread_attr_getscope</i>() and <i>pthread_attr_setscope</i>() functions are marked as part of the Threads and Thread
Execution Scheduling options.</p>
<p>The [ENOSYS] error condition has been removed as stubs need not be provided if an implementation does not support the Thread
Execution Scheduling option.</p>
<p>The <b>restrict</b> keyword is added to the <i>pthread_attr_getscope</i>() prototype for alignment with the
ISO/IEC&nbsp;9899:1999 standard.</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>