| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Proton DotNet: Apache.Qpid.Proton.Client.Concurrent.AtomicInteger 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="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Proton DotNet |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.9.1 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="namespaceApache.html">Apache</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid.html">Qpid</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton.html">Proton</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client.html">Client</a></li><li class="navelem"><a class="el" href="namespaceApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent.html">Concurrent</a></li><li class="navelem"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html">AtomicInteger</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#pub-static-methods">Static Public Member Functions</a> | |
| <a href="#properties">Properties</a> | |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">Apache.Qpid.Proton.Client.Concurrent.AtomicInteger Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Simple Atomic abstraction around the integer type to make atomic operations on integer types simpler to manage in code. The default value of this type is zero. |
| <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#details">More...</a></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:ad58ebd6a8f387d8a4f9a4adc0cddbc5d"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#ad58ebd6a8f387d8a4f9a4adc0cddbc5d">AtomicInteger</a> (int initialValue=0)</td></tr> |
| <tr class="memdesc:ad58ebd6a8f387d8a4f9a4adc0cddbc5d"><td class="mdescLeft"> </td><td class="mdescRight">Create a new instance with the given value or default to zero. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#ad58ebd6a8f387d8a4f9a4adc0cddbc5d">More...</a><br /></td></tr> |
| <tr class="separator:ad58ebd6a8f387d8a4f9a4adc0cddbc5d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a91b4c3353be9b5cb64bb9feb06ac9cfe"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#a91b4c3353be9b5cb64bb9feb06ac9cfe">CompareAndSet</a> (int expect, int update)</td></tr> |
| <tr class="memdesc:a91b4c3353be9b5cb64bb9feb06ac9cfe"><td class="mdescLeft"> </td><td class="mdescRight">Atomically sets the value to the new one if the current value == expected. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#a91b4c3353be9b5cb64bb9feb06ac9cfe">More...</a><br /></td></tr> |
| <tr class="separator:a91b4c3353be9b5cb64bb9feb06ac9cfe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a88bac674b14fba3ba8b5c1e0b1097706"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#a88bac674b14fba3ba8b5c1e0b1097706">IncrementAndGet</a> ()</td></tr> |
| <tr class="memdesc:a88bac674b14fba3ba8b5c1e0b1097706"><td class="mdescLeft"> </td><td class="mdescRight">Atomically increments the current value. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#a88bac674b14fba3ba8b5c1e0b1097706">More...</a><br /></td></tr> |
| <tr class="separator:a88bac674b14fba3ba8b5c1e0b1097706"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a57c8ec4f46f7cb010c5224a8f60cb4d7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#a57c8ec4f46f7cb010c5224a8f60cb4d7">DecrementAndGet</a> ()</td></tr> |
| <tr class="memdesc:a57c8ec4f46f7cb010c5224a8f60cb4d7"><td class="mdescLeft"> </td><td class="mdescRight">Atomically decrements the current value. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#a57c8ec4f46f7cb010c5224a8f60cb4d7">More...</a><br /></td></tr> |
| <tr class="separator:a57c8ec4f46f7cb010c5224a8f60cb4d7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad29e8fd0c699f99b6c38296b44d6f726"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#ad29e8fd0c699f99b6c38296b44d6f726">Get</a> ()</td></tr> |
| <tr class="memdesc:ad29e8fd0c699f99b6c38296b44d6f726"><td class="mdescLeft"> </td><td class="mdescRight">Reads the value of the integer atomically and returns it. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#ad29e8fd0c699f99b6c38296b44d6f726">More...</a><br /></td></tr> |
| <tr class="separator:ad29e8fd0c699f99b6c38296b44d6f726"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a68826b7550fb8e143f2e92f2598c6594"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#a68826b7550fb8e143f2e92f2598c6594">Set</a> (int newValue)</td></tr> |
| <tr class="memdesc:a68826b7550fb8e143f2e92f2598c6594"><td class="mdescLeft"> </td><td class="mdescRight">Performs an atomic write of the integer value. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#a68826b7550fb8e143f2e92f2598c6594">More...</a><br /></td></tr> |
| <tr class="separator:a68826b7550fb8e143f2e92f2598c6594"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> |
| Static Public Member Functions</h2></td></tr> |
| <tr class="memitem:af5888160f0cc6a650fa115c8b05fd0da"><td class="memItemLeft" align="right" valign="top"><a id="af5888160f0cc6a650fa115c8b05fd0da"></a> |
| static implicit </td><td class="memItemRight" valign="bottom"><b>operator int</b> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html">AtomicInteger</a> atomic)</td></tr> |
| <tr class="separator:af5888160f0cc6a650fa115c8b05fd0da"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a> |
| Properties</h2></td></tr> |
| <tr class="memitem:ab54d8589478cd40f9a92872565d36b5b"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#ab54d8589478cd40f9a92872565d36b5b">Value</a><code> [get]</code></td></tr> |
| <tr class="memdesc:ab54d8589478cd40f9a92872565d36b5b"><td class="mdescLeft"> </td><td class="mdescRight">Read the value of the integer atomically and return it. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicInteger.html#ab54d8589478cd40f9a92872565d36b5b">More...</a><br /></td></tr> |
| <tr class="separator:ab54d8589478cd40f9a92872565d36b5b"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Simple Atomic abstraction around the integer type to make atomic operations on integer types simpler to manage in code. The default value of this type is zero. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="ad58ebd6a8f387d8a4f9a4adc0cddbc5d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad58ebd6a8f387d8a4f9a4adc0cddbc5d">◆ </a></span>AtomicInteger()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">Apache.Qpid.Proton.Client.Concurrent.AtomicInteger.AtomicInteger </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>initialValue</em> = <code>0</code></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Create a new instance with the given value or default to zero. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">initialValue</td><td>Initial value for the int </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a91b4c3353be9b5cb64bb9feb06ac9cfe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a91b4c3353be9b5cb64bb9feb06ac9cfe">◆ </a></span>CompareAndSet()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool Apache.Qpid.Proton.Client.Concurrent.AtomicInteger.CompareAndSet </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>expect</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>update</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Atomically sets the value to the new one if the current value == expected. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">expect</td><td>The value that is expected</td></tr> |
| <tr><td class="paramname">update</td><td>The value to assign if the expectation is met.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd></dd></dl> |
| |
| </div> |
| </div> |
| <a id="a57c8ec4f46f7cb010c5224a8f60cb4d7"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a57c8ec4f46f7cb010c5224a8f60cb4d7">◆ </a></span>DecrementAndGet()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Apache.Qpid.Proton.Client.Concurrent.AtomicInteger.DecrementAndGet </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Atomically decrements the current value. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The decremented value</dd></dl> |
| |
| </div> |
| </div> |
| <a id="ad29e8fd0c699f99b6c38296b44d6f726"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ad29e8fd0c699f99b6c38296b44d6f726">◆ </a></span>Get()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Apache.Qpid.Proton.Client.Concurrent.AtomicInteger.Get </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Reads the value of the integer atomically and returns it. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The value of the integer</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a88bac674b14fba3ba8b5c1e0b1097706"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a88bac674b14fba3ba8b5c1e0b1097706">◆ </a></span>IncrementAndGet()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Apache.Qpid.Proton.Client.Concurrent.AtomicInteger.IncrementAndGet </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Atomically increments the current value. </p> |
| <dl class="section return"><dt>Returns</dt><dd>The incremented value</dd></dl> |
| |
| </div> |
| </div> |
| <a id="a68826b7550fb8e143f2e92f2598c6594"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a68826b7550fb8e143f2e92f2598c6594">◆ </a></span>Set()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void Apache.Qpid.Proton.Client.Concurrent.AtomicInteger.Set </td> |
| <td>(</td> |
| <td class="paramtype">int </td> |
| <td class="paramname"><em>newValue</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">inline</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Performs an atomic write of the integer value. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">newValue</td><td>The new value to assign to the integer</td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Property Documentation</h2> |
| <a id="ab54d8589478cd40f9a92872565d36b5b"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab54d8589478cd40f9a92872565d36b5b">◆ </a></span>Value</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">int Apache.Qpid.Proton.Client.Concurrent.AtomicInteger.Value</td> |
| </tr> |
| </table> |
| </td> |
| <td class="mlabels-right"> |
| <span class="mlabels"><span class="mlabel">get</span></span> </td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Read the value of the integer atomically and return it. </p> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li>src/Proton.Client/Client/Concurrent/AtomicInteger.cs</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 |
| </small></address> |
| </body> |
| </html> |
