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

193 lines
4.9 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!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_self()--Get Pthread Handle</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_self()--Get Pthread Handle</h2>
<div class="box" style="width: 50%;">
<br>
&nbsp;&nbsp;Syntax:
<pre>
#include &lt;pthread.h&gt;
pthread_t pthread_self(void);
</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: Yes<br>
<!-- iddvc RMBR -->
<br>
</div>
<p>The <strong>pthread_self</strong>() function returns the Pthread handle of
the calling thread. The pthread_self() function does <strong>NOT</strong>
return the integral thread of the calling thread. You must use
<strong>pthread_getthreadid_np</strong>() to return an integral identifier for
the thread.</p>
<p>If your code requires the unique integer identifier for the calling thread
often, or in a loop, the <strong>pthread_getthreadid_np</strong>() function can
provide significant performance improvements over the combination of
<strong>pthread_self</strong>(), and <strong>pthread_getunique_np</strong>()
calls that provide equivalent behavior.</p>
<p>For example:</p>
<pre>
pthread_id_np_t tid;
tid = pthread_getthreadid_np();
</pre>
<p>is significantly faster than these calls, but provides the same
behavior.</p>
<pre>
pthread_id_np_t tid;
pthread_t self;
self = pthread_self();
pthread_getunique_np(&amp;self, &amp;tid);
</pre>
<p>As always, if you are calling any function too often, performance
improvements can be gained by storing the results in a variable and or passing
to other functions which require the results.</p>
<br>
<h3>Authorities and Locks</h3>
<p>None.</p>
<br>
<h3>Parameters</h3>
<p>None.</p>
<br>
<h3>Return Value</h3>
<dl>
<dt><strong>pthread_t</strong></dt>
<dd><strong>pthread_self</strong>() returns the Pthread handle of the calling
thread.</dd>
</dl>
<br>
<h3>Error Conditions</h3>
<p>None.</p>
<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_17.htm">pthread_equal()</a>--Compare Two Threads<br><br></li>
<li><a href="users_22.htm">pthread_getthreadid_np()</a>--Retrieve Unique ID for
Calling Thread<br><br></li>
<li><a href="users_23.htm">pthread_getunique_np()</a>--Retrieve Unique ID for
Target Thread<br><br></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>
#include &lt;pthread.h&gt;
#include &lt;pthread.h&gt;
#include &lt;stdio.h&gt;
#include "check.h"
pthread_t theThread;
void *threadfunc(void *parm)
{
printf("Inside secondary thread\n");
theThread = pthread_self();
return NULL;
}
int main(int argc, char **argv)
{
pthread_t thread;
int rc=0;
printf("Entering testcase\n");
printf("Create thread using default attributes\n");
rc = pthread_create(&amp;thread, NULL, threadfunc, NULL);
checkResults("pthread_create()\n", rc);
/* sleep() is not a very robust way to wait for the thread */
sleep(5);
printf("Check if the thread got its thread handle\n");
if (!pthread_equal(thread, theThread)) {
printf("Unexpected results on pthread_equal()!\n");
exit(1);
}
printf("pthread_self() returned the thread handle\n");
printf("Main completed\n");
return 0;
}
</pre>
<p><strong>Output:</strong></p>
<pre>
Entering testcase
Create thread using default attributes
Inside secondary thread
Check if the thread got its thread handle
pthread_self() returned the thread handle
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>