Sophie

Sophie

distrib > Mandriva > 2010.1 > i586 > by-pkgid > ed376d6842ea322c25405e7c23b3bc12 > files > 288

libcommoncpp-devel-1.8.0-5.1mdv2010.1.i586.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>GNU CommonC++: ost::PosixThread Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_posix_thread.html">PosixThread</a>
  </div>
</div>
<div class="contents">
<h1>ost::PosixThread Class Reference</h1><!-- doxytag: class="ost::PosixThread" --><!-- doxytag: inherits="ost::Thread" -->
<p><code>#include &lt;<a class="el" href="thread_8h_source.html">thread.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for ost::PosixThread:</div>
<div class="dynsection">
 <div class="center">
  <img src="classost_1_1_posix_thread.png" usemap="#ost::PosixThread_map" alt=""/>
  <map id="ost::PosixThread_map" name="ost::PosixThread_map">
<area href="classost_1_1_thread.html" alt="ost::Thread" shape="rect" coords="0,0,104,24"/>
</map>
 </div>
</div>

<p><a href="classost_1_1_posix_thread-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#aeeba18c7e3ef9f718b20b7477e602735">PosixThread</a> (int pri=0, size_t stack=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#afa168ff1446785a43b1123703d999207">signalThread</a> (int signo)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Delivers a Posix signal to the current thread.  <a href="#afa168ff1446785a43b1123703d999207"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#a67e582aabcd65431a38ecc8cbf0af350">sigInstall</a> (int signo)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Install a signal handler for use by threads and the OnSignal() event notification handler.  <a href="#a67e582aabcd65431a38ecc8cbf0af350"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#a1698de2b943084fe05849cbd42099156">signalParent</a> (<a class="el" href="namespaceost.html#a5dca865b107f598c88bd2106ea56c16e">signo_t</a> signo)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="#a1698de2b943084fe05849cbd42099156"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#ad13ab707409d229be9c5b64a0e2ec7ad">signalMain</a> (<a class="el" href="namespaceost.html#a5dca865b107f598c88bd2106ea56c16e">signo_t</a> signo)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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="#ad13ab707409d229be9c5b64a0e2ec7ad"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#a9ce41764e5846b94195d367a0c7c7e4e">onTimer</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A derivable method to call when a SIGALRM is being delivered to a specific thread.  <a href="#a9ce41764e5846b94195d367a0c7c7e4e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#acfb12beb826e7895f54a5af9e6c38434">onHangup</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A derived method to handle hangup events being delivered to a specific thread.  <a href="#acfb12beb826e7895f54a5af9e6c38434"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#adb1aa6d0e6baa04c37e1a61b641414e7">onException</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A derived method to call when a SIGABRT is being delivered to a specific thread.  <a href="#adb1aa6d0e6baa04c37e1a61b641414e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#a105a9f61fcdf62acd3d5563f5d9e3905">onDisconnect</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A derived method to call when a SIGPIPE is being delivered to a specific thread.  <a href="#a105a9f61fcdf62acd3d5563f5d9e3905"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#a6e2788cfba0b31813d4cab891f7e1feb">onPolling</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A derived method to handle asynchronous I/O requests delivered to the specified thread.  <a href="#a6e2788cfba0b31813d4cab891f7e1feb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#a3db7c01850d939ca1bb0fdc67aeb3efa">onSignal</a> (int)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A derivable method to call for delivering a signal event to a specified thread.  <a href="#a3db7c01850d939ca1bb0fdc67aeb3efa"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#ad9c8ffa69fec8c3a139fe3d7068667a0">setTimer</a> (<a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timer, bool periodic=false)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to specify a timeout event that can be delivered to the current thread via SIGALRM.  <a href="#ad9c8ffa69fec8c3a139fe3d7068667a0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#a79beb0fde40ee5073fe6468de94eef05">getTimer</a> (void) const </td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the time remaining for the current threads timer before it expires.  <a href="#a79beb0fde40ee5073fe6468de94eef05"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#aed0f4cae60e5694960260d13664c1367">endTimer</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Terminates the timer before the timeout period has expired.  <a href="#aed0f4cae60e5694960260d13664c1367"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#a1545316f7caaabf86edd1874eada6732">waitSignal</a> (<a class="el" href="namespaceost.html#a5dca865b107f598c88bd2106ea56c16e">signo_t</a> signo)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to wait on a Posix signal from another thread.  <a href="#a1545316f7caaabf86edd1874eada6732"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#ab665136ffddf808ab652c51f9caa953c">setSignal</a> (int signo, bool active)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Used to enable or disable a signal within the current thread.  <a href="#ab665136ffddf808ab652c51f9caa953c"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">pthread_attr_t *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#ae7b26aaccd916f0905a30707d7ef4067">getPthreadAttrPtr</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</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" title="Every thread of execution in an application is created by instantiating an object...">Thread</a> constructor, e.g.  <a href="#ae7b26aaccd916f0905a30707d7ef4067"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">pthread_t&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#af114ce4574592143ef016dd9cd2bd11d">getPthreadId</a> (void)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get pthread_t of underlying posix thread (useful for debugging/logging).  <a href="#af114ce4574592143ef016dd9cd2bd11d"></a><br/></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#ae3c1cdb20d70b22a5c0bf395614eefff">ThreadImpl</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_posix_thread.html#adbc148eaddd341d7ae4d07c9e9e33bfd">Thread</a></td></tr>
</table>
<hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aeeba18c7e3ef9f718b20b7477e602735"></a><!-- doxytag: member="ost::PosixThread::PosixThread" ref="aeeba18c7e3ef9f718b20b7477e602735" args="(int pri=0, size_t stack=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ost::PosixThread::PosixThread </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>pri</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&nbsp;</td>
          <td class="paramname"> <em>stack</em> = <code>0</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aed0f4cae60e5694960260d13664c1367"></a><!-- doxytag: member="ost::PosixThread::endTimer" ref="aed0f4cae60e5694960260d13664c1367" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::PosixThread::endTimer </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Terminates the timer before the timeout period has expired. </p>
<p>This prevents the timer from sending it's SIGALRM and makes the timer available to other threads. </p>

</div>
</div>
<a class="anchor" id="ae7b26aaccd916f0905a30707d7ef4067"></a><!-- doxytag: member="ost::PosixThread::getPthreadAttrPtr" ref="ae7b26aaccd916f0905a30707d7ef4067" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">pthread_attr_t* ost::PosixThread::getPthreadAttrPtr </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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" title="Every thread of execution in an application is created by instantiating an object...">Thread</a> constructor, e.g. </p>
<p>contention scope or scheduling policy </p>

</div>
</div>
<a class="anchor" id="af114ce4574592143ef016dd9cd2bd11d"></a><!-- doxytag: member="ost::PosixThread::getPthreadId" ref="af114ce4574592143ef016dd9cd2bd11d" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">pthread_t ost::PosixThread::getPthreadId </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Get pthread_t of underlying posix thread (useful for debugging/logging). </p>

</div>
</div>
<a class="anchor" id="a79beb0fde40ee5073fe6468de94eef05"></a><!-- doxytag: member="ost::PosixThread::getTimer" ref="a79beb0fde40ee5073fe6468de94eef05" args="(void) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ost::PosixThread::getTimer </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Gets the time remaining for the current threads timer before it expires. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>time remaining before timer expires in milliseconds. </dd></dl>

</div>
</div>
<a class="anchor" id="a105a9f61fcdf62acd3d5563f5d9e3905"></a><!-- doxytag: member="ost::PosixThread::onDisconnect" ref="a105a9f61fcdf62acd3d5563f5d9e3905" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::PosixThread::onDisconnect </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A derived method to call when a SIGPIPE is being delivered to a specific thread. </p>

</div>
</div>
<a class="anchor" id="adb1aa6d0e6baa04c37e1a61b641414e7"></a><!-- doxytag: member="ost::PosixThread::onException" ref="adb1aa6d0e6baa04c37e1a61b641414e7" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::PosixThread::onException </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A derived method to call when a SIGABRT is being delivered to a specific thread. </p>

</div>
</div>
<a class="anchor" id="acfb12beb826e7895f54a5af9e6c38434"></a><!-- doxytag: member="ost::PosixThread::onHangup" ref="acfb12beb826e7895f54a5af9e6c38434" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::PosixThread::onHangup </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A derived method to handle hangup events being delivered to a specific thread. </p>

</div>
</div>
<a class="anchor" id="a6e2788cfba0b31813d4cab891f7e1feb"></a><!-- doxytag: member="ost::PosixThread::onPolling" ref="a6e2788cfba0b31813d4cab891f7e1feb" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::PosixThread::onPolling </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A derived method to handle asynchronous I/O requests delivered to the specified thread. </p>

</div>
</div>
<a class="anchor" id="a3db7c01850d939ca1bb0fdc67aeb3efa"></a><!-- doxytag: member="ost::PosixThread::onSignal" ref="a3db7c01850d939ca1bb0fdc67aeb3efa" args="(int)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::PosixThread::onSignal </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A derivable method to call for delivering a signal event to a specified thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>-</em>&nbsp;</td><td>posix signal id. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a9ce41764e5846b94195d367a0c7c7e4e"></a><!-- doxytag: member="ost::PosixThread::onTimer" ref="a9ce41764e5846b94195d367a0c7c7e4e" args="(void)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void ost::PosixThread::onTimer </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>A derivable method to call when a SIGALRM is being delivered to a specific thread. </p>

</div>
</div>
<a class="anchor" id="ab665136ffddf808ab652c51f9caa953c"></a><!-- doxytag: member="ost::PosixThread::setSignal" ref="ab665136ffddf808ab652c51f9caa953c" args="(int signo, bool active)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::PosixThread::setSignal </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>signo</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>active</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to enable or disable a signal within the current thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>signo</em>&nbsp;</td><td>posix signal id. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>active</em>&nbsp;</td><td>set to true to enable. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ad9c8ffa69fec8c3a139fe3d7068667a0"></a><!-- doxytag: member="ost::PosixThread::setTimer" ref="ad9c8ffa69fec8c3a139fe3d7068667a0" args="(timeout_t timer, bool periodic=false)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::PosixThread::setTimer </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="thread_8h.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a>&nbsp;</td>
          <td class="paramname"> <em>timer</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>periodic</em> = <code>false</code></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to specify a timeout event that can be delivered to the current thread via SIGALRM. </p>
<p>When the timer expires, the <a class="el" href="classost_1_1_posix_thread.html#a9ce41764e5846b94195d367a0c7c7e4e" title="A derivable method to call when a SIGALRM is being delivered to a specific thread...">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><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>timer</em>&nbsp;</td><td>timeout in milliseconds. </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>periodic</em>&nbsp;</td><td>should the timer be periodic. </td></tr>
  </table>
  </dd>
</dl>
<dl class="note"><dt><b>Note:</b></dt><dd>currently, periodic timers are only available on systems with a working setitimer call. </dd></dl>

</div>
</div>
<a class="anchor" id="a67e582aabcd65431a38ecc8cbf0af350"></a><!-- doxytag: member="ost::PosixThread::sigInstall" ref="a67e582aabcd65431a38ecc8cbf0af350" args="(int signo)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void ost::PosixThread::sigInstall </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>signo</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Install a signal handler for use by threads and the OnSignal() event notification handler. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>signo</em>&nbsp;</td><td>posix signal id. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ad13ab707409d229be9c5b64a0e2ec7ad"></a><!-- doxytag: member="ost::PosixThread::signalMain" ref="ad13ab707409d229be9c5b64a0e2ec7ad" args="(signo_t signo)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::PosixThread::signalMain </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a5dca865b107f598c88bd2106ea56c16e">signo_t</a>&nbsp;</td>
          <td class="paramname"> <em>signo</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>In the Posix version of Common C++, this can be used to send a signal into the main application thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>signo</em>&nbsp;</td><td>a posix signal id. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1698de2b943084fe05849cbd42099156"></a><!-- doxytag: member="ost::PosixThread::signalParent" ref="a1698de2b943084fe05849cbd42099156" args="(signo_t signo)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::PosixThread::signalParent </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a5dca865b107f598c88bd2106ea56c16e">signo_t</a>&nbsp;</td>
          <td class="paramname"> <em>signo</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<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><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>signo</em>&nbsp;</td><td>a posix signal id. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="afa168ff1446785a43b1123703d999207"></a><!-- doxytag: member="ost::PosixThread::signalThread" ref="afa168ff1446785a43b1123703d999207" args="(int signo)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::PosixThread::signalThread </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>signo</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Delivers a Posix signal to the current thread. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>signo</em>&nbsp;</td><td>a posix signal id. </td></tr>
  </table>
  </dd>
</dl>

<p>References <a class="el" href="thread_8h_source.html#l01680">signalThread()</a>.</p>

<p>Referenced by <a class="el" href="thread_8h_source.html#l01680">signalThread()</a>.</p>

</div>
</div>
<a class="anchor" id="a1545316f7caaabf86edd1874eada6732"></a><!-- doxytag: member="ost::PosixThread::waitSignal" ref="a1545316f7caaabf86edd1874eada6732" args="(signo_t signo)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ost::PosixThread::waitSignal </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceost.html#a5dca865b107f598c88bd2106ea56c16e">signo_t</a>&nbsp;</td>
          <td class="paramname"> <em>signo</em></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Used to wait on a Posix signal from another thread. </p>
<p>This can be used as a crude rondevious/synchronization method between threads.</p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>signo</em>&nbsp;</td><td>a posix signal id. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/><h2>Friends And Related Function Documentation</h2>
<a class="anchor" id="adbc148eaddd341d7ae4d07c9e9e33bfd"></a><!-- doxytag: member="ost::PosixThread::Thread" ref="adbc148eaddd341d7ae4d07c9e9e33bfd" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class <a class="el" href="classost_1_1_thread.html">Thread</a><code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

</div>
</div>
<a class="anchor" id="ae3c1cdb20d70b22a5c0bf395614eefff"></a><!-- doxytag: member="ost::PosixThread::ThreadImpl" ref="ae3c1cdb20d70b22a5c0bf395614eefff" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">friend class ThreadImpl<code> [friend]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Reimplemented from <a class="el" href="classost_1_1_thread.html#ae3c1cdb20d70b22a5c0bf395614eefff">ost::Thread</a>.</p>

</div>
</div>
<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></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:48 2010 for GNU CommonC++ by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>