Sophie

Sophie

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

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 Namespace 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 class="current"><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li><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="namespaces.html"><span>Namespace List</span></a></li>
    <li><a href="namespacemembers.html"><span>Namespace&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></div>
<h1>CS::Threading Namespace Reference</h1>Functions and classes for threading, locking and atomic operations.  
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1AtomicOperationsBase.html">AtomicOperationsBase</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Define low-level atomic operations.  <a href="classCS_1_1Threading_1_1AtomicOperationsBase.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1Condition.html">Condition</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classCS_1_1Threading_1_1Condition.html" title="Condition variable.">Condition</a> variable.  <a href="classCS_1_1Threading_1_1Condition.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">MutexImpl</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">General mutex class.  <a href="classCS_1_1Threading_1_1MutexImpl.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1Runnable.html">Runnable</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Abstract base class for objects to be run in threads.  <a href="classCS_1_1Threading_1_1Runnable.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ScopedLock.html">ScopedLock</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">This is a utility class for locking a Mutex.  <a href="classCS_1_1Threading_1_1ScopedLock.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1Thread.html">Thread</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Object representing a separate execution thread.  <a href="classCS_1_1Threading_1_1Thread.html#_details">More...</a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadedJobQueue.html">ThreadedJobQueue</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCS_1_1Threading_1_1ThreadGroup.html">ThreadGroup</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">A group of threads handled as one unit.  <a href="classCS_1_1Threading_1_1ThreadGroup.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">namespace &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCS_1_1Threading_1_1Implementation.html">Implementation</a></td></tr>

<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">MutexImpl</a><br>
&lt; Implementation::MutexBase &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCS_1_1Threading.html#a77233dd556d212f73dba0999f0cb596">Mutex</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Basic non-recursive mutex.  <a href="#a77233dd556d212f73dba0999f0cb596"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c8299196d93b306c8cdda17e9fd42464"></a><!-- doxytag: member="CS::Threading::MutexScopedLock" ref="c8299196d93b306c8cdda17e9fd42464" args="" -->
typedef <a class="el" href="classCS_1_1Threading_1_1ScopedLock.html">ScopedLock</a><br>
&lt; <a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">Mutex</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCS_1_1Threading.html#c8299196d93b306c8cdda17e9fd42464">MutexScopedLock</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">MutexImpl</a><br>
&lt; Implementation::RecursiveMutexBase &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCS_1_1Threading.html#adf3126962fadbc6a7ed6fff9f318ba6">RecursiveMutex</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Basic recursive mutex.  <a href="#adf3126962fadbc6a7ed6fff9f318ba6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="9cfab1149a1836ca407a06c2d00ed0b8"></a><!-- doxytag: member="CS::Threading::RecursiveMutexScopedLock" ref="9cfab1149a1836ca407a06c2d00ed0b8" args="" -->
typedef <a class="el" href="classCS_1_1Threading_1_1ScopedLock.html">ScopedLock</a><br>
&lt; <a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">RecursiveMutex</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCS_1_1Threading.html#9cfab1149a1836ca407a06c2d00ed0b8">RecursiveMutexScopedLock</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCS_1_1Threading.html#040b603ebb091edd68db17f7b4f1f988">ThreadID</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">OS specific thread identifier.  <a href="#040b603ebb091edd68db17f7b4f1f988"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceCS_1_1Threading.html#785461563cc5ad5580177ae429bbb239">ThreadPriority</a> { <a class="el" href="namespaceCS_1_1Threading.html#785461563cc5ad5580177ae429bbb2398186b75ecc38a7b0c8aaf34a9809bd24">THREAD_PRIO_LOW</a>, 
<a class="el" href="namespaceCS_1_1Threading.html#785461563cc5ad5580177ae429bbb239c39edebc95da17ce08b6a8c1234177ae">THREAD_PRIO_NORMAL</a>, 
<a class="el" href="namespaceCS_1_1Threading.html#785461563cc5ad5580177ae429bbb239c2ad92a96167409696c9ad05c77c5706">THREAD_PRIO_HIGH</a>
 }</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Priority values indicate how frequently a thread runs compared to other threads.  <a href="namespaceCS_1_1Threading.html#785461563cc5ad5580177ae429bbb239">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Functions and classes for threading, locking and atomic operations. <hr><h2>Typedef Documentation</h2>
<a class="anchor" name="a77233dd556d212f73dba0999f0cb596"></a><!-- doxytag: member="CS::Threading::Mutex" ref="a77233dd556d212f73dba0999f0cb596" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">MutexImpl</a>&lt;Implementation::MutexBase&gt; <a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">CS::Threading::Mutex</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Basic non-recursive mutex. 
<p>

<p>Definition at line <a class="el" href="mutex_8h-source.html#l00117">117</a> of file <a class="el" href="mutex_8h-source.html">mutex.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="adf3126962fadbc6a7ed6fff9f318ba6"></a><!-- doxytag: member="CS::Threading::RecursiveMutex" ref="adf3126962fadbc6a7ed6fff9f318ba6" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">MutexImpl</a>&lt;Implementation::RecursiveMutexBase&gt; <a class="el" href="classCS_1_1Threading_1_1MutexImpl.html">CS::Threading::RecursiveMutex</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Basic recursive mutex. 
<p>
The difference between a normal mutex and recursive mutex is that a recursive mutex won't lock if same thread try to enter it several times. 
<p>Definition at line <a class="el" href="mutex_8h-source.html#l00124">124</a> of file <a class="el" href="mutex_8h-source.html">mutex.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="040b603ebb091edd68db17f7b4f1f988"></a><!-- doxytag: member="CS::Threading::ThreadID" ref="040b603ebb091edd68db17f7b4f1f988" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef unsigned int <a class="el" href="namespaceCS_1_1Threading.html#040b603ebb091edd68db17f7b4f1f988">CS::Threading::ThreadID</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
OS specific thread identifier. 
<p>

<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00070">70</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>

</div>
</div><p>
<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="785461563cc5ad5580177ae429bbb239"></a><!-- doxytag: member="CS::Threading::ThreadPriority" ref="785461563cc5ad5580177ae429bbb239" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="namespaceCS_1_1Threading.html#785461563cc5ad5580177ae429bbb239">CS::Threading::ThreadPriority</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Priority values indicate how frequently a thread runs compared to other threads. 
<p>
<a class="el" href="classCS_1_1Threading_1_1Thread.html" title="Object representing a separate execution thread.">Thread</a> scheduling is handled by the underlying OS, and so the true meaning of these values will vary depending on platform. A minimal set of values is defined for <a class="el" href="namespaceCS.html" title="Main namespace for CrystalSpace.">CS</a> so that chances of support of the full range of values by the platform are greater. <dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="785461563cc5ad5580177ae429bbb2398186b75ecc38a7b0c8aaf34a9809bd24"></a><!-- doxytag: member="THREAD_PRIO_LOW" ref="785461563cc5ad5580177ae429bbb2398186b75ecc38a7b0c8aaf34a9809bd24" args="" -->THREAD_PRIO_LOW</em>&nbsp;</td><td>
Reduced thread priority. Useful for background tasks. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="785461563cc5ad5580177ae429bbb239c39edebc95da17ce08b6a8c1234177ae"></a><!-- doxytag: member="THREAD_PRIO_NORMAL" ref="785461563cc5ad5580177ae429bbb239c39edebc95da17ce08b6a8c1234177ae" args="" -->THREAD_PRIO_NORMAL</em>&nbsp;</td><td>
Normal thread priority. </td></tr>
<tr><td valign="top"><em><a class="anchor" name="785461563cc5ad5580177ae429bbb239c2ad92a96167409696c9ad05c77c5706"></a><!-- doxytag: member="THREAD_PRIO_HIGH" ref="785461563cc5ad5580177ae429bbb239c2ad92a96167409696c9ad05c77c5706" args="" -->THREAD_PRIO_HIGH</em>&nbsp;</td><td>
Increased thread priority. 
<p>
Useful for tasks that needs precedence over all other. </td></tr>
</table>
</dl>

<p>Definition at line <a class="el" href="threading_2thread_8h-source.html#l00038">38</a> of file <a class="el" href="threading_2thread_8h-source.html">thread.h</a>.</p>

</div>
</div><p>
<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>