<!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"/> <title>GNU CommonC++: ost::AtomicCounter Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <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 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 class="tabs"> <ul> <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 class="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_atomic_counter.html">AtomicCounter</a> </div> </div> <div class="contents"> <h1>ost::AtomicCounter Class Reference</h1><!-- doxytag: class="ost::AtomicCounter" --> <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="#_details">More...</a></p> <p><code>#include <<a class="el" href="thread_8h_source.html">thread.h</a>></code></p> <p><a href="classost_1_1_atomic_counter-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><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><td class="mdescLeft"> </td><td class="mdescRight">Initialize an atomic counter to 0. <a href="#ae44557ac95d1e1526ad02dcf7c81dc36"></a><br/></td></tr> <tr><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><td class="mdescLeft"> </td><td class="mdescRight">Initialize an atomic counter to a known value. <a href="#a004464040b9f78cb18ebf6467212b3c9"></a><br/></td></tr> <tr><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><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><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><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><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><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><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><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><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><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> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <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="author"><dt><b>Author:</b></dt><dd>Sean Cavanaugh <<a href="mailto:sean@dimensionalrift.com">sean@dimensionalrift.com</a>> atomic counter operation. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ae44557ac95d1e1526ad02dcf7c81dc36"></a><!-- doxytag: member="ost::AtomicCounter::AtomicCounter" ref="ae44557ac95d1e1526ad02dcf7c81dc36" args="()" --> <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><!-- doxytag: member="ost::AtomicCounter::AtomicCounter" ref="a004464040b9f78cb18ebf6467212b3c9" args="(int value)" --> <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><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> </dd> </dl> </div> </div> <a class="anchor" id="a7b9046be70726e7eb240f4efe0e011b7"></a><!-- doxytag: member="ost::AtomicCounter::~AtomicCounter" ref="a7b9046be70726e7eb240f4efe0e011b7" args="()" --> <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> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a8ee3bcf3d61dfdaa0f7fac8469bbb1b5"></a><!-- doxytag: member="ost::AtomicCounter::operator int" ref="a8ee3bcf3d61dfdaa0f7fac8469bbb1b5" args="()" --> <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><!-- doxytag: member="ost::AtomicCounter::operator!" ref="a3e8b4023edf8a1bc8c54eb4b23dda5f9" args="(void)" --> <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><!-- doxytag: member="ost::AtomicCounter::operator+" ref="a7f7cba5fbc973f7e1bf3f9edf6930144" args="(int change)" --> <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><!-- doxytag: member="ost::AtomicCounter::operator++" ref="a349673acccaf8bec1e3a1ef75a09f3ad" args="(void)" --> <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><!-- doxytag: member="ost::AtomicCounter::operator+=" ref="ad001e499d8c5396b168fe73d8ac2d414" args="(int change)" --> <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><!-- doxytag: member="ost::AtomicCounter::operator-" ref="a3b4f8261461cff8bfa43df8a8f6141b5" args="(int change)" --> <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><!-- doxytag: member="ost::AtomicCounter::operator--" ref="a9188ebc2b9c15b85a672d55090c98988" args="(void)" --> <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><!-- doxytag: member="ost::AtomicCounter::operator-=" ref="a4b2ee002defdb42a8c65930de8317328" args="(int change)" --> <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><!-- doxytag: member="ost::AtomicCounter::operator=" ref="a0b9546c50c3c34c9188a5c31fdf8d5dd" args="(int value)" --> <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> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Mar 12 10:07:42 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>