<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::AtomicCounter Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="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 Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_atomic_counter.html">AtomicCounter</a></div>
<h1>ost::AtomicCounter Class Reference</h1><!-- doxytag: class="ost::AtomicCounter" -->The <a class="el" href="classost_1_1_atomic_counter.html">AtomicCounter</a> class offers thread-safe manipulation of an integer counter.atomic counter operation.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="thread_8h-source.html">thread.h</a>></code>
<p>
<a href="classost_1_1_atomic_counter-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#e44557ac95d1e1526ad02dcf7c81dc36">AtomicCounter</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize an atomic counter to 0. <a href="#e44557ac95d1e1526ad02dcf7c81dc36"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#004464040b9f78cb18ebf6467212b3c9">AtomicCounter</a> (int value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize an atomic counter to a known value. <a href="#004464040b9f78cb18ebf6467212b3c9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#7b9046be70726e7eb240f4efe0e011b7">~AtomicCounter</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#349673acccaf8bec1e3a1ef75a09f3ad">operator++</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#9188ebc2b9c15b85a672d55090c98988">operator--</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#d001e499d8c5396b168fe73d8ac2d414">operator+=</a> (int change)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#4b2ee002defdb42a8c65930de8317328">operator-=</a> (int change)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#7f7cba5fbc973f7e1bf3f9edf6930144">operator+</a> (int change)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#3b4f8261461cff8bfa43df8a8f6141b5">operator-</a> (int change)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#0b9546c50c3c34c9188a5c31fdf8d5dd">operator=</a> (int value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#3e8b4023edf8a1bc8c54eb4b23dda5f9">operator!</a> (void)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#8ee3bcf3d61dfdaa0f7fac8469bbb1b5">operator int</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classost_1_1_atomic_counter.html">AtomicCounter</a> class offers thread-safe manipulation of an integer counter.atomic counter operation.
<p>
These are commonly used for building thread-safe "reference" counters for C++ classes. The <a class="el" href="classost_1_1_atomic_counter.html">AtomicCounter</a> depends on the platforms support for "atomic" integer operations, and can alternately substitute a "mutex" if no atomic support exists.<p>
<dl compact><dt><b>Author:</b></dt><dd>Sean Cavanaugh <<a href="mailto:sean@dimensionalrift.com">sean@dimensionalrift.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="e44557ac95d1e1526ad02dcf7c81dc36"></a><!-- doxytag: member="ost::AtomicCounter::AtomicCounter" ref="e44557ac95d1e1526ad02dcf7c81dc36" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::AtomicCounter::AtomicCounter </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Initialize an atomic counter to 0.
<p>
</td>
</tr>
</table>
<a class="anchor" name="004464040b9f78cb18ebf6467212b3c9"></a><!-- doxytag: member="ost::AtomicCounter::AtomicCounter" ref="004464040b9f78cb18ebf6467212b3c9" args="(int value)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::AtomicCounter::AtomicCounter </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Initialize an atomic counter to a known value.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>value</em> </td><td>initial value. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="7b9046be70726e7eb240f4efe0e011b7"></a><!-- doxytag: member="ost::AtomicCounter::~AtomicCounter" ref="7b9046be70726e7eb240f4efe0e011b7" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::AtomicCounter::~AtomicCounter </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8ee3bcf3d61dfdaa0f7fac8469bbb1b5"></a><!-- doxytag: member="ost::AtomicCounter::operator int" ref="8ee3bcf3d61dfdaa0f7fac8469bbb1b5" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::AtomicCounter::operator int </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="3e8b4023edf8a1bc8c54eb4b23dda5f9"></a><!-- doxytag: member="ost::AtomicCounter::operator!" ref="3e8b4023edf8a1bc8c54eb4b23dda5f9" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::AtomicCounter::operator! </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="7f7cba5fbc973f7e1bf3f9edf6930144"></a><!-- doxytag: member="ost::AtomicCounter::operator+" ref="7f7cba5fbc973f7e1bf3f9edf6930144" args="(int change)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::AtomicCounter::operator+ </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>change</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="349673acccaf8bec1e3a1ef75a09f3ad"></a><!-- doxytag: member="ost::AtomicCounter::operator++" ref="349673acccaf8bec1e3a1ef75a09f3ad" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::AtomicCounter::operator++ </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="d001e499d8c5396b168fe73d8ac2d414"></a><!-- doxytag: member="ost::AtomicCounter::operator+=" ref="d001e499d8c5396b168fe73d8ac2d414" args="(int change)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::AtomicCounter::operator+= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>change</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="3b4f8261461cff8bfa43df8a8f6141b5"></a><!-- doxytag: member="ost::AtomicCounter::operator-" ref="3b4f8261461cff8bfa43df8a8f6141b5" args="(int change)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::AtomicCounter::operator- </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>change</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="9188ebc2b9c15b85a672d55090c98988"></a><!-- doxytag: member="ost::AtomicCounter::operator--" ref="9188ebc2b9c15b85a672d55090c98988" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::AtomicCounter::operator-- </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="4b2ee002defdb42a8c65930de8317328"></a><!-- doxytag: member="ost::AtomicCounter::operator-=" ref="4b2ee002defdb42a8c65930de8317328" args="(int change)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::AtomicCounter::operator-= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>change</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="0b9546c50c3c34c9188a5c31fdf8d5dd"></a><!-- doxytag: member="ost::AtomicCounter::operator=" ref="0b9546c50c3c34c9188a5c31fdf8d5dd" args="(int value)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::AtomicCounter::operator= </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname1" valign="top" nowrap> <em>value</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:57 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
