Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 984

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csRunnable Class Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <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="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <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>
<h1>csRunnable Class Reference</h1><!-- doxytag: class="csRunnable" -->Abstract interface for objects which can be run in a thread.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="thread_8h-source.html">csutil/thread.h</a>&gt;</code>
<p>

<p>
<a href="classcsRunnable-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">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRunnable.html#55efa1db1a7d178dcb4bb0da96bfd56a">DecRef</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Decrement reference count.  <a href="#55efa1db1a7d178dcb4bb0da96bfd56a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRunnable.html#dbc3e72f46424389e86447066dc51972">GetRefCount</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get reference count.  <a href="#dbc3e72f46424389e86447066dc51972"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRunnable.html#16254cb87076b1c92d4ab74e955f7f90">IncRef</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Increment reference count.  <a href="#16254cb87076b1c92d4ab74e955f7f90"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRunnable.html#92eef3efda1388219e00146629f3a597">Run</a> ()=0</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Implement this method to allow your object to be run in a thread.  <a href="#92eef3efda1388219e00146629f3a597"></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">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classcsRunnable.html#7ce023ce123572b5faed3560c7ee1a3e">~csRunnable</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Needed for GCC4.  <a href="#7ce023ce123572b5faed3560c7ee1a3e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Abstract interface for objects which can be run in a thread. 
<p>
Objects which want to be run in a thread must implement this interface. <dl compact><dt><b><a class="el" href="deprecated.html#_deprecated000073">Deprecated:</a></b></dt><dd><a class="el" href="classcsRunnable.html" title="Abstract interface for objects which can be run in a thread.">csRunnable</a> is deprecated. Use new subsystem in <a class="el" href="namespaceCS_1_1Threading.html" title="Functions and classes for threading, locking and atomic operations.">CS::Threading</a> instead </dd></dl>

<p>Definition at line <a class="el" href="thread_8h-source.html#l00077">77</a> of file <a class="el" href="thread_8h-source.html">thread.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="7ce023ce123572b5faed3560c7ee1a3e"></a><!-- doxytag: member="csRunnable::~csRunnable" ref="7ce023ce123572b5faed3560c7ee1a3e" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual csRunnable::~csRunnable           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Needed for GCC4. 
<p>
Otherwise emits a flood of "virtual functions but non-virtual destructor" warnings. 
<p>Definition at line <a class="el" href="thread_8h-source.html#l00085">85</a> of file <a class="el" href="thread_8h-source.html">thread.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="55efa1db1a7d178dcb4bb0da96bfd56a"></a><!-- doxytag: member="csRunnable::DecRef" ref="55efa1db1a7d178dcb4bb0da96bfd56a" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csRunnable::DecRef           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Decrement reference count. 
<p>

</div>
</div><p>
<a class="anchor" name="dbc3e72f46424389e86447066dc51972"></a><!-- doxytag: member="csRunnable::GetRefCount" ref="dbc3e72f46424389e86447066dc51972" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual int csRunnable::GetRefCount           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get reference count. 
<p>

</div>
</div><p>
<a class="anchor" name="16254cb87076b1c92d4ab74e955f7f90"></a><!-- doxytag: member="csRunnable::IncRef" ref="16254cb87076b1c92d4ab74e955f7f90" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csRunnable::IncRef           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Increment reference count. 
<p>

</div>
</div><p>
<a class="anchor" name="92eef3efda1388219e00146629f3a597"></a><!-- doxytag: member="csRunnable::Run" ref="92eef3efda1388219e00146629f3a597" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual void csRunnable::Run           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Implement this method to allow your object to be run in a thread. 
<p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="thread_8h-source.html">thread.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>