<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::PosixThread Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_posix_thread.html">PosixThread</a></div>
<h1>ost::PosixThread Class Reference</h1><!-- doxytag: class="ost::PosixThread" --><!-- doxytag: inherits="ost::Thread" --><code>#include <<a class="el" href="thread_8h-source.html">thread.h</a>></code>
<p>
<p>Inheritance diagram for ost::PosixThread:
<p><center><img src="classost_1_1_posix_thread.png" usemap="#ost::PosixThread_map" border="0" alt=""></center>
<map name="ost::PosixThread_map">
<area href="classost_1_1_thread.html" alt="ost::Thread" shape="rect" coords="0,0,104,24">
</map>
<a href="classost_1_1_posix_thread-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#eeba18c7e3ef9f718b20b7477e602735">PosixThread</a> (int pri=0, size_t stack=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#fa168ff1446785a43b1123703d999207">signalThread</a> (int signo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delivers a Posix signal to the current thread. <a href="#fa168ff1446785a43b1123703d999207"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#67e582aabcd65431a38ecc8cbf0af350">sigInstall</a> (int signo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Install a signal handler for use by threads and the OnSignal() event notification handler. <a href="#67e582aabcd65431a38ecc8cbf0af350"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#1698de2b943084fe05849cbd42099156">signalParent</a> (<a class="el" href="namespaceost.html#5dca865b107f598c88bd2106ea56c16e">signo_t</a> signo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">In the Posix version of Common C++, this can be used to send a signal into the parent thread of the current object. <a href="#1698de2b943084fe05849cbd42099156"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#d13ab707409d229be9c5b64a0e2ec7ad">signalMain</a> (<a class="el" href="namespaceost.html#5dca865b107f598c88bd2106ea56c16e">signo_t</a> signo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">In the Posix version of Common C++, this can be used to send a signal into the main application thread. <a href="#d13ab707409d229be9c5b64a0e2ec7ad"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#9ce41764e5846b94195d367a0c7c7e4e">onTimer</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A derivable method to call when a SIGALRM is being delivered to a specific thread. <a href="#9ce41764e5846b94195d367a0c7c7e4e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#cfb12beb826e7895f54a5af9e6c38434">onHangup</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A derived method to handle hangup events being delivered to a specific thread. <a href="#cfb12beb826e7895f54a5af9e6c38434"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#db1aa6d0e6baa04c37e1a61b641414e7">onException</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A derived method to call when a SIGABRT is being delivered to a specific thread. <a href="#db1aa6d0e6baa04c37e1a61b641414e7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#105a9f61fcdf62acd3d5563f5d9e3905">onDisconnect</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A derived method to call when a SIGPIPE is being delivered to a specific thread. <a href="#105a9f61fcdf62acd3d5563f5d9e3905"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#6e2788cfba0b31813d4cab891f7e1feb">onPolling</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A derived method to handle asynchronous I/O requests delivered to the specified thread. <a href="#6e2788cfba0b31813d4cab891f7e1feb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#3db7c01850d939ca1bb0fdc67aeb3efa">onSignal</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A derivable method to call for delivering a signal event to a specified thread. <a href="#3db7c01850d939ca1bb0fdc67aeb3efa"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#d9c8ffa69fec8c3a139fe3d7068667a0">setTimer</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer, bool periodic=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to specify a timeout event that can be delivered to the current thread via SIGALRM. <a href="#d9c8ffa69fec8c3a139fe3d7068667a0"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#79beb0fde40ee5073fe6468de94eef05">getTimer</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the time remaining for the current threads timer before it expires. <a href="#79beb0fde40ee5073fe6468de94eef05"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#ed0f4cae60e5694960260d13664c1367">endTimer</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Terminates the timer before the timeout period has expired. <a href="#ed0f4cae60e5694960260d13664c1367"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#b665136ffddf808ab652c51f9caa953c">setSignal</a> (int signo, bool active)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to enable or disable a signal within the current thread. <a href="#b665136ffddf808ab652c51f9caa953c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">pthread_attr_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#e7b26aaccd916f0905a30707d7ef4067">getPthreadAttrPtr</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Access to pthread_attr structure this allows setting/modifying pthread attributes not covered in the platform independant <a class="el" href="classost_1_1_thread.html">Thread</a> constructor, e.g. <a href="#e7b26aaccd916f0905a30707d7ef4067"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">pthread_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#f114ce4574592143ef016dd9cd2bd11d">getPthreadId</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get pthread_t of underlying posix thread (useful for debugging/logging). <a href="#f114ce4574592143ef016dd9cd2bd11d"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#e3c1cdb20d70b22a5c0bf395614eefff">ThreadImpl</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#dbc148eaddd341d7ae4d07c9e9e33bfd">Thread</a></td></tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="eeba18c7e3ef9f718b20b7477e602735"></a><!-- doxytag: member="ost::PosixThread::PosixThread" ref="eeba18c7e3ef9f718b20b7477e602735" args="(int pri=0, size_t stack=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::PosixThread::PosixThread </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>pri</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>size_t </td>
<td class="mdname" nowrap> <em>stack</em> = <code>0</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ed0f4cae60e5694960260d13664c1367"></a><!-- doxytag: member="ost::PosixThread::endTimer" ref="ed0f4cae60e5694960260d13664c1367" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::PosixThread::endTimer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Terminates the timer before the timeout period has expired.
<p>
This prevents the timer from sending it's SIGALRM and makes the timer available to other threads. </td>
</tr>
</table>
<a class="anchor" name="e7b26aaccd916f0905a30707d7ef4067"></a><!-- doxytag: member="ost::PosixThread::getPthreadAttrPtr" ref="e7b26aaccd916f0905a30707d7ef4067" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">pthread_attr_t* ost::PosixThread::getPthreadAttrPtr </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Access to pthread_attr structure this allows setting/modifying pthread attributes not covered in the platform independant <a class="el" href="classost_1_1_thread.html">Thread</a> constructor, e.g.
<p>
contention scope or scheduling policy </td>
</tr>
</table>
<a class="anchor" name="f114ce4574592143ef016dd9cd2bd11d"></a><!-- doxytag: member="ost::PosixThread::getPthreadId" ref="f114ce4574592143ef016dd9cd2bd11d" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">pthread_t ost::PosixThread::getPthreadId </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get pthread_t of underlying posix thread (useful for debugging/logging).
<p>
</td>
</tr>
</table>
<a class="anchor" name="79beb0fde40ee5073fe6468de94eef05"></a><!-- doxytag: member="ost::PosixThread::getTimer" ref="79beb0fde40ee5073fe6468de94eef05" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ost::PosixThread::getTimer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Gets the time remaining for the current threads timer before it expires.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>time remaining before timer expires in milliseconds. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="105a9f61fcdf62acd3d5563f5d9e3905"></a><!-- doxytag: member="ost::PosixThread::onDisconnect" ref="105a9f61fcdf62acd3d5563f5d9e3905" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::PosixThread::onDisconnect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A derived method to call when a SIGPIPE is being delivered to a specific thread.
<p>
</td>
</tr>
</table>
<a class="anchor" name="db1aa6d0e6baa04c37e1a61b641414e7"></a><!-- doxytag: member="ost::PosixThread::onException" ref="db1aa6d0e6baa04c37e1a61b641414e7" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::PosixThread::onException </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A derived method to call when a SIGABRT is being delivered to a specific thread.
<p>
</td>
</tr>
</table>
<a class="anchor" name="cfb12beb826e7895f54a5af9e6c38434"></a><!-- doxytag: member="ost::PosixThread::onHangup" ref="cfb12beb826e7895f54a5af9e6c38434" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::PosixThread::onHangup </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A derived method to handle hangup events being delivered to a specific thread.
<p>
</td>
</tr>
</table>
<a class="anchor" name="6e2788cfba0b31813d4cab891f7e1feb"></a><!-- doxytag: member="ost::PosixThread::onPolling" ref="6e2788cfba0b31813d4cab891f7e1feb" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::PosixThread::onPolling </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A derived method to handle asynchronous I/O requests delivered to the specified thread.
<p>
</td>
</tr>
</table>
<a class="anchor" name="3db7c01850d939ca1bb0fdc67aeb3efa"></a><!-- doxytag: member="ost::PosixThread::onSignal" ref="3db7c01850d939ca1bb0fdc67aeb3efa" args="(int)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::PosixThread::onSignal </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A derivable method to call for delivering a signal event to a specified thread.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>-</em> </td><td>posix signal id. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="9ce41764e5846b94195d367a0c7c7e4e"></a><!-- doxytag: member="ost::PosixThread::onTimer" ref="9ce41764e5846b94195d367a0c7c7e4e" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::PosixThread::onTimer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
A derivable method to call when a SIGALRM is being delivered to a specific thread.
<p>
</td>
</tr>
</table>
<a class="anchor" name="b665136ffddf808ab652c51f9caa953c"></a><!-- doxytag: member="ost::PosixThread::setSignal" ref="b665136ffddf808ab652c51f9caa953c" args="(int signo, bool active)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::PosixThread::setSignal </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>signo</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>active</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to enable or disable a signal within the current thread.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>signo</em> </td><td>posix signal id. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>active</em> </td><td>set to true to enable. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="d9c8ffa69fec8c3a139fe3d7068667a0"></a><!-- doxytag: member="ost::PosixThread::setTimer" ref="d9c8ffa69fec8c3a139fe3d7068667a0" args="(timeout_t timer, bool periodic=false)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::PosixThread::setTimer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname" nowrap> <em>timer</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>bool </td>
<td class="mdname" nowrap> <em>periodic</em> = <code>false</code></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to specify a timeout event that can be delivered to the current thread via SIGALRM.
<p>
When the timer expires, the <a class="el" href="classost_1_1_posix_thread.html#9ce41764e5846b94195d367a0c7c7e4e">onTimer()</a> method is called for the thread. At present, only one thread timer can be active at any given time. On some operating systems (including Linux) a timer can be active on each thread.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timer</em> </td><td>timeout in milliseconds. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>periodic</em> </td><td>should the timer be periodic. </td></tr>
</table>
</dl>
<dl compact><dt><b>Note:</b></dt><dd>currently, periodic timers are only available on systems with a working setitimer call. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="67e582aabcd65431a38ecc8cbf0af350"></a><!-- doxytag: member="ost::PosixThread::sigInstall" ref="67e582aabcd65431a38ecc8cbf0af350" args="(int signo)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">static void ost::PosixThread::sigInstall </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>signo</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [static]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Install a signal handler for use by threads and the OnSignal() event notification handler.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>signo</em> </td><td>posix signal id. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="d13ab707409d229be9c5b64a0e2ec7ad"></a><!-- doxytag: member="ost::PosixThread::signalMain" ref="d13ab707409d229be9c5b64a0e2ec7ad" args="(signo_t signo)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::PosixThread::signalMain </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#5dca865b107f598c88bd2106ea56c16e">signo_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>signo</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
In the Posix version of Common C++, this can be used to send a signal into the main application thread.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>signo</em> </td><td>a posix signal id. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="1698de2b943084fe05849cbd42099156"></a><!-- doxytag: member="ost::PosixThread::signalParent" ref="1698de2b943084fe05849cbd42099156" args="(signo_t signo)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::PosixThread::signalParent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="namespaceost.html#5dca865b107f598c88bd2106ea56c16e">signo_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>signo</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
In the Posix version of Common C++, this can be used to send a signal into the parent thread of the current object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>signo</em> </td><td>a posix signal id. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="fa168ff1446785a43b1123703d999207"></a><!-- doxytag: member="ost::PosixThread::signalThread" ref="fa168ff1446785a43b1123703d999207" args="(int signo)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::PosixThread::signalThread </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>signo</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Delivers a Posix signal to the current thread.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>signo</em> </td><td>a posix signal id. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="dbc148eaddd341d7ae4d07c9e9e33bfd"></a><!-- doxytag: member="ost::PosixThread::Thread" ref="dbc148eaddd341d7ae4d07c9e9e33bfd" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">friend class <a class="el" href="classost_1_1_thread.html">Thread</a><code> [friend]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="e3c1cdb20d70b22a5c0bf395614eefff"></a><!-- doxytag: member="ost::PosixThread::ThreadImpl" ref="e3c1cdb20d70b22a5c0bf395614eefff" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">friend class ThreadImpl<code> [friend]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
<p>
Reimplemented from <a class="el" href="classost_1_1_thread.html#e3c1cdb20d70b22a5c0bf395614eefff">ost::Thread</a>. </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="thread_8h-source.html">thread.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
