<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>GNU CommonC++: ost::AtomicCounter Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU CommonC++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_atomic_counter.html">AtomicCounter</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classost_1_1_atomic_counter-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ost::AtomicCounter Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The <a class="el" href="classost_1_1_atomic_counter.html" title="The AtomicCounter class offers thread-safe manipulation of an integer counter. ">AtomicCounter</a> class offers thread-safe manipulation of an integer counter.
<a href="classost_1_1_atomic_counter.html#details">More...</a></p>
<p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ae44557ac95d1e1526ad02dcf7c81dc36"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#ae44557ac95d1e1526ad02dcf7c81dc36">AtomicCounter</a> ()</td></tr>
<tr class="memdesc:ae44557ac95d1e1526ad02dcf7c81dc36"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an atomic counter to 0. <a href="#ae44557ac95d1e1526ad02dcf7c81dc36">More...</a><br/></td></tr>
<tr class="separator:ae44557ac95d1e1526ad02dcf7c81dc36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a004464040b9f78cb18ebf6467212b3c9"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a004464040b9f78cb18ebf6467212b3c9">AtomicCounter</a> (int value)</td></tr>
<tr class="memdesc:a004464040b9f78cb18ebf6467212b3c9"><td class="mdescLeft"> </td><td class="mdescRight">Initialize an atomic counter to a known value. <a href="#a004464040b9f78cb18ebf6467212b3c9">More...</a><br/></td></tr>
<tr class="separator:a004464040b9f78cb18ebf6467212b3c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7b9046be70726e7eb240f4efe0e011b7"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a7b9046be70726e7eb240f4efe0e011b7">~AtomicCounter</a> ()</td></tr>
<tr class="separator:a7b9046be70726e7eb240f4efe0e011b7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a349673acccaf8bec1e3a1ef75a09f3ad"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a349673acccaf8bec1e3a1ef75a09f3ad">operator++</a> (void)</td></tr>
<tr class="separator:a349673acccaf8bec1e3a1ef75a09f3ad"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9188ebc2b9c15b85a672d55090c98988"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a9188ebc2b9c15b85a672d55090c98988">operator--</a> (void)</td></tr>
<tr class="separator:a9188ebc2b9c15b85a672d55090c98988"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad001e499d8c5396b168fe73d8ac2d414"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#ad001e499d8c5396b168fe73d8ac2d414">operator+=</a> (int change)</td></tr>
<tr class="separator:ad001e499d8c5396b168fe73d8ac2d414"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4b2ee002defdb42a8c65930de8317328"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a4b2ee002defdb42a8c65930de8317328">operator-=</a> (int change)</td></tr>
<tr class="separator:a4b2ee002defdb42a8c65930de8317328"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7f7cba5fbc973f7e1bf3f9edf6930144"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a7f7cba5fbc973f7e1bf3f9edf6930144">operator+</a> (int change)</td></tr>
<tr class="separator:a7f7cba5fbc973f7e1bf3f9edf6930144"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3b4f8261461cff8bfa43df8a8f6141b5"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a3b4f8261461cff8bfa43df8a8f6141b5">operator-</a> (int change)</td></tr>
<tr class="separator:a3b4f8261461cff8bfa43df8a8f6141b5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0b9546c50c3c34c9188a5c31fdf8d5dd"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a0b9546c50c3c34c9188a5c31fdf8d5dd">operator=</a> (int value)</td></tr>
<tr class="separator:a0b9546c50c3c34c9188a5c31fdf8d5dd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3e8b4023edf8a1bc8c54eb4b23dda5f9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a3e8b4023edf8a1bc8c54eb4b23dda5f9">operator!</a> (void)</td></tr>
<tr class="separator:a3e8b4023edf8a1bc8c54eb4b23dda5f9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ee3bcf3d61dfdaa0f7fac8469bbb1b5"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_atomic_counter.html#a8ee3bcf3d61dfdaa0f7fac8469bbb1b5">operator int</a> ()</td></tr>
<tr class="separator:a8ee3bcf3d61dfdaa0f7fac8469bbb1b5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The <a class="el" href="classost_1_1_atomic_counter.html" title="The AtomicCounter class offers thread-safe manipulation of an integer counter. ">AtomicCounter</a> class offers thread-safe manipulation of an integer counter. </p>
<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" title="The AtomicCounter class offers thread-safe manipulation of an integer counter. ">AtomicCounter</a> depends on the platforms support for "atomic" integer operations, and can alternately substitute a "mutex" if no atomic support exists.</p>
<dl class="section author"><dt>Author</dt><dd>Sean Cavanaugh <a href="#" onclick="location.href='mai'+'lto:'+'sea'+'n@'+'dim'+'en'+'sio'+'na'+'lri'+'ft'+'.co'+'m'; return false;">sean@<span style="display: none;">.nosp@m.</span>dime<span style="display: none;">.nosp@m.</span>nsion<span style="display: none;">.nosp@m.</span>alri<span style="display: none;">.nosp@m.</span>ft.co<span style="display: none;">.nosp@m.</span>m</a> atomic counter operation. </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ae44557ac95d1e1526ad02dcf7c81dc36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::AtomicCounter::AtomicCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an atomic counter to 0. </p>
</div>
</div>
<a class="anchor" id="a004464040b9f78cb18ebf6467212b3c9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::AtomicCounter::AtomicCounter </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize an atomic counter to a known value. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>initial value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a7b9046be70726e7eb240f4efe0e011b7"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::AtomicCounter::~AtomicCounter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8ee3bcf3d61dfdaa0f7fac8469bbb1b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ost::AtomicCounter::operator int </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3e8b4023edf8a1bc8c54eb4b23dda5f9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ost::AtomicCounter::operator! </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7f7cba5fbc973f7e1bf3f9edf6930144"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::AtomicCounter::operator+ </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>change</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a349673acccaf8bec1e3a1ef75a09f3ad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::AtomicCounter::operator++ </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ad001e499d8c5396b168fe73d8ac2d414"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::AtomicCounter::operator+= </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>change</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a3b4f8261461cff8bfa43df8a8f6141b5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::AtomicCounter::operator- </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>change</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a9188ebc2b9c15b85a672d55090c98988"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::AtomicCounter::operator-- </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a4b2ee002defdb42a8c65930de8317328"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::AtomicCounter::operator-= </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>change</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a0b9546c50c3c34c9188a5c31fdf8d5dd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int ost::AtomicCounter::operator= </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 17 2013 23:24:58 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
