Sophie

Sophie

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

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: CS::Threading::AtomicOperationsBase&lt; Impl &gt; Class Template 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>
<div class="nav">
<a class="el" href="namespaceCS.html">CS</a>::<a class="el" href="namespaceCS_1_1Threading.html">Threading</a>::<a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">AtomicOperationsBase</a></div>
<h1>CS::Threading::AtomicOperationsBase&lt; Impl &gt; Class Template Reference</h1><!-- doxytag: class="CS::Threading::AtomicOperationsBase" -->Define low-level atomic operations.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="atomicops_8h-source.html">csutil/threading/atomicops.h</a>&gt;</code>
<p>

<p>
<a href="classCS_1_1Threading_1_1AtomicOperationsBase-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></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 <br>
CS_FORCEINLINE_TEMPLATEMETHOD <br>
void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html#2bd72f8102e1e5302c6a5a00c5b5e960">CompareAndSet</a> (void **target, void *value, void *comparand)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare pointer pointed to by target with comparand, if they are equal set pointer pointed to by target to value, otherwise do nothing.  <a href="#2bd72f8102e1e5302c6a5a00c5b5e960"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
CS_FORCEINLINE_TEMPLATEMETHOD <br>
<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html#6702b4cfd34450b116015f6281465049">CompareAndSet</a> (<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *target, <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> value, <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> comparand)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Compare value pointed to by target with comparand, if they are equal set value pointed to by target to value, otherwise do nothing.  <a href="#6702b4cfd34450b116015f6281465049"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
CS_FORCEINLINE_TEMPLATEMETHOD <br>
<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html#c25d5d5252d6d6a0edcc6d652620c803">Decrement</a> (<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Atomically decrement value pointed to by target.  <a href="#c25d5d5252d6d6a0edcc6d652620c803"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
CS_FORCEINLINE_TEMPLATEMETHOD <br>
<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html#9f8998687c7be0033093aa676bc04e67">Increment</a> (<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Atomically increment value pointed to by target.  <a href="#9f8998687c7be0033093aa676bc04e67"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
CS_FORCEINLINE_TEMPLATEMETHOD <br>
void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html#b1d28f7c187d680f5ec041f421bb99c8">Read</a> (void **target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Atomically read pointer pointed to by target.  <a href="#b1d28f7c187d680f5ec041f421bb99c8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
CS_FORCEINLINE_TEMPLATEMETHOD <br>
<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html#b9772579b40cbf25124a51a7601dfd67">Read</a> (<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *target)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Atomically read value pointed to by target.  <a href="#b9772579b40cbf25124a51a7601dfd67"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
CS_FORCEINLINE_TEMPLATEMETHOD <br>
void *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html#4684b87f483886bce2d7a878ea12f018">Set</a> (void **target, void *value)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set pointer pointed to by target to value and return previous value.  <a href="#4684b87f483886bce2d7a878ea12f018"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <br>
CS_FORCEINLINE_TEMPLATEMETHOD <br>
<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html#5e82929a142c8bd4f69a067b24989edd">Set</a> (<a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *target, <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> value)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set value pointed to by target to value and return previous value.  <a href="#5e82929a142c8bd4f69a067b24989edd"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename Impl&gt;<br>
 class CS::Threading::AtomicOperationsBase&lt; Impl &gt;</h3>

Define low-level atomic operations. 
<p>
These operations are truly atomic on the processor, and thereby safe to use on shared variables in a multi-threaded environment. 
<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00036">36</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2bd72f8102e1e5302c6a5a00c5b5e960"></a><!-- doxytag: member="CS::Threading::AtomicOperationsBase::CompareAndSet" ref="2bd72f8102e1e5302c6a5a00c5b5e960" args="(void **target, void *value, void *comparand)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Impl&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static CS_FORCEINLINE_TEMPLATEMETHOD void* <a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">CS::Threading::AtomicOperationsBase</a>&lt; Impl &gt;::CompareAndSet           </td>
          <td>(</td>
          <td class="paramtype">void **&nbsp;</td>
          <td class="paramname"> <em>target</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>comparand</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compare pointer pointed to by target with comparand, if they are equal set pointer pointed to by target to value, otherwise do nothing. 
<p>
Returns initial pointer pointed to by target. 
<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00075">75</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="6702b4cfd34450b116015f6281465049"></a><!-- doxytag: member="CS::Threading::AtomicOperationsBase::CompareAndSet" ref="6702b4cfd34450b116015f6281465049" args="(int32 *target, int32 value, int32 comparand)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Impl&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static CS_FORCEINLINE_TEMPLATEMETHOD <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> <a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">CS::Threading::AtomicOperationsBase</a>&lt; Impl &gt;::CompareAndSet           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *&nbsp;</td>
          <td class="paramname"> <em>target</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td>
          <td class="paramname"> <em>value</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td>
          <td class="paramname"> <em>comparand</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compare value pointed to by target with comparand, if they are equal set value pointed to by target to value, otherwise do nothing. 
<p>
Returns initial value pointed to by target. 
<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00063">63</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="c25d5d5252d6d6a0edcc6d652620c803"></a><!-- doxytag: member="CS::Threading::AtomicOperationsBase::Decrement" ref="c25d5d5252d6d6a0edcc6d652620c803" args="(int32 *target)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Impl&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static CS_FORCEINLINE_TEMPLATEMETHOD <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> <a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">CS::Threading::AtomicOperationsBase</a>&lt; Impl &gt;::Decrement           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *&nbsp;</td>
          <td class="paramname"> <em>target</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Atomically decrement value pointed to by target. 
<p>
Returns value after decrement. 
<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00096">96</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="9f8998687c7be0033093aa676bc04e67"></a><!-- doxytag: member="CS::Threading::AtomicOperationsBase::Increment" ref="9f8998687c7be0033093aa676bc04e67" args="(int32 *target)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Impl&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static CS_FORCEINLINE_TEMPLATEMETHOD <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> <a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">CS::Threading::AtomicOperationsBase</a>&lt; Impl &gt;::Increment           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *&nbsp;</td>
          <td class="paramname"> <em>target</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Atomically increment value pointed to by target. 
<p>
Returns value after increment. 
<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00086">86</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b1d28f7c187d680f5ec041f421bb99c8"></a><!-- doxytag: member="CS::Threading::AtomicOperationsBase::Read" ref="b1d28f7c187d680f5ec041f421bb99c8" args="(void **target)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Impl&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static CS_FORCEINLINE_TEMPLATEMETHOD void* <a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">CS::Threading::AtomicOperationsBase</a>&lt; Impl &gt;::Read           </td>
          <td>(</td>
          <td class="paramtype">void **&nbsp;</td>
          <td class="paramname"> <em>target</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Atomically read pointer pointed to by target. 
<p>

<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00114">114</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b9772579b40cbf25124a51a7601dfd67"></a><!-- doxytag: member="CS::Threading::AtomicOperationsBase::Read" ref="b9772579b40cbf25124a51a7601dfd67" args="(int32 *target)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Impl&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static CS_FORCEINLINE_TEMPLATEMETHOD <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> <a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">CS::Threading::AtomicOperationsBase</a>&lt; Impl &gt;::Read           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *&nbsp;</td>
          <td class="paramname"> <em>target</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Atomically read value pointed to by target. 
<p>

<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00105">105</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="4684b87f483886bce2d7a878ea12f018"></a><!-- doxytag: member="CS::Threading::AtomicOperationsBase::Set" ref="4684b87f483886bce2d7a878ea12f018" args="(void **target, void *value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Impl&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static CS_FORCEINLINE_TEMPLATEMETHOD void* <a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">CS::Threading::AtomicOperationsBase</a>&lt; Impl &gt;::Set           </td>
          <td>(</td>
          <td class="paramtype">void **&nbsp;</td>
          <td class="paramname"> <em>target</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set pointer pointed to by target to value and return previous value. 
<p>

<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00052">52</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="5e82929a142c8bd4f69a067b24989edd"></a><!-- doxytag: member="CS::Threading::AtomicOperationsBase::Set" ref="5e82929a142c8bd4f69a067b24989edd" args="(int32 *target, int32 value)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename Impl&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">static CS_FORCEINLINE_TEMPLATEMETHOD <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> <a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">CS::Threading::AtomicOperationsBase</a>&lt; Impl &gt;::Set           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *&nbsp;</td>
          <td class="paramname"> <em>target</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td>
          <td class="paramname"> <em>value</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline, static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set value pointed to by target to value and return previous value. 
<p>

<p>Definition at line <a class="el" href="atomicops_8h-source.html#l00043">43</a> of file <a class="el" href="atomicops_8h-source.html">atomicops.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/threading/<a class="el" href="atomicops_8h-source.html">atomicops.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>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional