ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/users_21.htm

198 lines
5.6 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<title>pthread_getschedparam()--Get Thread Scheduling Parameters</title>
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Begin Header Records ========================================== -->
<!-- NETMG2 SCRIPT A converted by B2H R4.1 (346) (CMS) by HOLTJM at -->
<!-- RCHVMW2 on 29 Jan 1999 at 10:01:37 -->
<!--File Edited November 2001 --><!--End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</head>
<body>
<!-- Java sync-link -->
<script language="Javascript" src="../rzahg/synch.js" type="text/javascript">
</script>
<a name="Top_Of_Page"></a>
<h2>pthread_getschedparam()--Get Thread Scheduling Parameters</h2>
<div class="box" style="width: 65%;">
<br>
&nbsp;&nbsp;Syntax:
<pre>
#include &lt;pthread.h&gt;
#include &lt;sched.h&gt;
int pthread_getschedparam(pthread_t thread, int *policy,
struct sched_param *param);
</pre>
&nbsp;&nbsp;Service Program Name: QP0WPTHR<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Default Public Authority: *USE<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Threadsafe: Yes<br>
<!-- iddvc RMBR -->
<br>
&nbsp;&nbsp;Signal Safe: No<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>pthread_getschedparam</strong>() function retrieves the
scheduling parameters of the <em>thread</em>. The default i5/OS scheduling
policy is <strong>SCHED_OTHER</strong> and cannot be changed to another
scheduling policy.</p>
<p>The <em>sched_policy</em> field of the <em>param</em> parameter is always
returned as <strong>SCHED_OTHER.</strong> The sched_priority field of the
<em>param</em> structure is set to the priority of the target thread at the
time of the call.</p>
<p><strong>Note:</strong> Do not use <strong>pthread_setschedparam</strong>()
to set the priority of a thread if you also use another mechanism (other than
the pthread APIs) to set the priority of a thread. If you do,
<strong>pthread_getschedparam</strong>() returns only that information that was
set by the pthread interfaces such as <strong>pthread_setschedparam</strong>()
or a modification of the thread attribute using
<strong>pthread_attr_setschedparam</strong>().</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Parameters</h3>
<dl>
<dt><strong>thread</strong></dt>
<dd>(Input) Pthread handle representing the target thread<br><br></dd>
<dt><strong>policy</strong></dt>
<dd>(Output) Address of the variable to contain the scheduling policy<br><br></dd>
<dt><strong>param</strong></dt>
<dd>(Output) Address of the variable to contain the scheduling parameters</dd>
</dl>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>0</strong></dt>
<dd><strong>pthread_getschedparam</strong>() was successful.<br><br></dd>
<dt><strong>value</strong></dt>
<dd><strong>pthread_getschedparam</strong> was not successful. <em>value</em>
is set to indicate the error condition.</dd>
</dl>
<br>
<h3>Error Conditions</h3>
<p>If <strong>pthread_getschedparam</strong>() was not successful, the error
condition returned usually indicates one of the following errors. Under some
conditions, the value returned could indicate an error other than those listed
here.</p>
<dl>
<dt><em>[EINVAL]</em></dt>
<dd><p>The value specified for the argument is not correct.</p></dd>
</dl>
<br>
<h3>Related Information</h3>
<ul>
<li>The &lt;<strong>pthread.h</strong>&gt; header file. See <a href=
"rzah4hed.htm">Header files for Pthread functions</a>.<br><br></li>
<li><a href="users_31.htm">pthread_setschedparam()</a>--Set Target Thread
Scheduling Parameters</li>
</ul>
<br>
<h3>Example</h3>
<p>See <a href="../apiref/aboutapis.htm#codedisclaimer">Code disclaimer information</a>
for information pertaining to code examples.</p>
<pre>
#define _MULTI_THREADED
#include &lt;pthread.h&gt;
#include &lt;sched.h&gt;
#include &lt;stdio.h&gt;
#include "check.h"
void *threadfunc(void *parm)
{
printf("Inside secondary thread\n");
sleep(5); /* Sleep is not a very robust way to serialize threads */
return NULL;
}
int main(int argc, char **argv)
{
pthread_t thread;
int rc=0;
struct sched_param param;
int policy;
printf("Enter Testcase - %s\n", argv[0]);
printf("Create thread using default attributes\n");
rc = pthread_create(&amp;thread, NULL, threadfunc, NULL);
checkResults("pthread_create()\n", rc);
printf("Get scheduling parameters\n");
rc = pthread_getschedparam(thread, &amp;policy, &amp;param);
checkResults("pthread_getschedparam()\n", rc);
printf("The thread scheduling parameters indicate:\n"
"policy = %d\n", policy);
printf("priority = %d\n",
param.sched_priority);
printf("Main completed\n");
return 0;
}
</pre>
<p><strong>Output:</strong></p>
<pre>
Enter Testcase - QP0WTEST/TPGSP0
Create thread using default attributes
Get scheduling parameters
The thread scheduling parameters indicate:
policy = 0
priority = 0
Main completed
</pre>
<br>
<hr>API introduced: V4R3
<hr>
<center>
<table cellpadding="2" cellspacing="2">
<tr align="center">
<td valign="middle" align="center"><a href="#Top_Of_Page">Top</a> | <a href=
"rzah4mst.htm">Pthread APIs</a> | <a href="aplist.htm">APIs by
category</a></td>
</tr>
</table>
</center>
</body>
</html>