Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 88959ca903fe50462ea99715ead18944 > files > 165

raul-devel-0.7.0-1.fc14.1.x86_64.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>RAUL: Raul::Slave 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.7.1 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="modules.html"><span>Modules</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>
    </ul>
  </div>
  <div class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&nbsp;List</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">
    <ul>
      <li><b>Raul</b>      </li>
      <li><a class="el" href="classRaul_1_1Slave.html">Raul::Slave</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<h1>Raul::Slave Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::Slave" --><!-- doxytag: inherits="Raul::Thread" -->
<p><a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> driven by (realtime safe) signals.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="Slave_8hpp_source.html">Slave.hpp</a>&gt;</code></p>

<p>Inherits <a class="el" href="classRaul_1_1Thread.html">Raul::Thread</a>.</p>
<div class="dynheader">
Collaboration diagram for Raul::Slave:</div>
<div class="dyncontent">
<div class="center"><img src="classRaul_1_1Slave__coll__graph.png" border="0" usemap="#Raul_1_1Slave_coll__map" alt="Collaboration graph"/></div>
<map name="Raul_1_1Slave_coll__map" id="Raul_1_1Slave_coll__map">
<area shape="rect" id="node2" href="classRaul_1_1Thread.html" title="Abstract base class for a thread." alt="" coords="5,5,101,35"/><area shape="rect" id="node4" href="classRaul_1_1Semaphore.html" title="Trivial wrapper around POSIX semaphores (zero memory overhead)." alt="" coords="125,5,248,35"/></map>
</div>

<p><a href="classRaul_1_1Slave-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public 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="classRaul_1_1Slave.html#a72d3a921abae1efaaede6d5f5bd4f8ac">whip</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Tell the slave to do whatever work it does.  <a href="#a72d3a921abae1efaaede6d5f5bd4f8ac"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Slave.html#ae702d0bfe12869a978b126a8bfc87363">_whipped</a> ()=0</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Worker method.  <a href="#ae702d0bfe12869a978b126a8bfc87363"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a370efe514418a96ba80455367bb8a2c4"></a><!-- doxytag: member="Raul::Slave::_whip" ref="a370efe514418a96ba80455367bb8a2c4" args="" -->
<a class="el" href="classRaul_1_1Semaphore.html">Semaphore</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>_whip</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p><a class="el" href="classRaul_1_1Thread.html" title="Abstract base class for a thread.">Thread</a> driven by (realtime safe) signals. </p>
<p>Use this to perform some task in a separate thread you want to 'drive' from a realtime (or otherwise) thread. </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a72d3a921abae1efaaede6d5f5bd4f8ac"></a><!-- doxytag: member="Raul::Slave::whip" ref="a72d3a921abae1efaaede6d5f5bd4f8ac" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Raul::Slave::whip </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Tell the slave to do whatever work it does. </p>
<p>Realtime safe. </p>

<p>References <a class="el" href="classRaul_1_1Semaphore.html#a5ae17e57432268156acaa23561eafe27">Raul::Semaphore::post()</a>.</p>

</div>
</div>
<a class="anchor" id="ae702d0bfe12869a978b126a8bfc87363"></a><!-- doxytag: member="Raul::Slave::_whipped" ref="ae702d0bfe12869a978b126a8bfc87363" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void Raul::Slave::_whipped </td>
          <td>(</td>
          <td class="paramname"></td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Worker method. </p>
<p>This is called once from this thread every time <a class="el" href="classRaul_1_1Slave.html#a72d3a921abae1efaaede6d5f5bd4f8ac" title="Tell the slave to do whatever work it does.">whip()</a> is called. Implementations likely want to put a single (non loop) chunk of code here, e.g. to process an event. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Slave_8hpp_source.html">Slave.hpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>