Google Git
Sign in
apache / qpid-site / refs/heads/asf-site / . / content / releases / qpid-proton-dotnet-1.0.0-M10 / api / classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html
blob: 5b6d4a99a37ff5a81d0dd6a5f790b102e0abf908 [file] [log] [blame]
<!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.AtomicBoolean 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&amp;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&amp;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_1AtomicBoolean.html">AtomicBoolean</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-methods">Static Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Qpid.Proton.Client.Concurrent.AtomicBoolean Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Provides a boolean value that may be updated and read atomically.
<a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.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:a09f00d9ebc13caa8d2b6e91c2a823925"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#a09f00d9ebc13caa8d2b6e91c2a823925">AtomicBoolean</a> (bool initialValue=false)</td></tr>
<tr class="memdesc:a09f00d9ebc13caa8d2b6e91c2a823925"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a new atomic boolean instance with either the given value or defaults to false. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#a09f00d9ebc13caa8d2b6e91c2a823925">More...</a><br /></td></tr>
<tr class="separator:a09f00d9ebc13caa8d2b6e91c2a823925"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a716a9490882fda76c4a23d0589bb8130"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#a716a9490882fda76c4a23d0589bb8130">CompareAndSet</a> (bool expect, bool update)</td></tr>
<tr class="memdesc:a716a9490882fda76c4a23d0589bb8130"><td class="mdescLeft">&#160;</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_1AtomicBoolean.html#a716a9490882fda76c4a23d0589bb8130">More...</a><br /></td></tr>
<tr class="separator:a716a9490882fda76c4a23d0589bb8130"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aacde1fc5076cf5e36dd32bff47692415"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#aacde1fc5076cf5e36dd32bff47692415">Get</a> ()</td></tr>
<tr class="memdesc:aacde1fc5076cf5e36dd32bff47692415"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads the value of the boolean atomically and returns it. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#aacde1fc5076cf5e36dd32bff47692415">More...</a><br /></td></tr>
<tr class="separator:aacde1fc5076cf5e36dd32bff47692415"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a452329bfe13fcf2346f2a71fc5f25992"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#a452329bfe13fcf2346f2a71fc5f25992">Set</a> (bool newValue)</td></tr>
<tr class="memdesc:a452329bfe13fcf2346f2a71fc5f25992"><td class="mdescLeft">&#160;</td><td class="mdescRight">Performs an atomic write of the boolean value. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#a452329bfe13fcf2346f2a71fc5f25992">More...</a><br /></td></tr>
<tr class="separator:a452329bfe13fcf2346f2a71fc5f25992"><td class="memSeparator" colspan="2">&#160;</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:a18c7dc277fcf1a3be019bc400c930f29"><td class="memItemLeft" align="right" valign="top"><a id="a18c7dc277fcf1a3be019bc400c930f29"></a>
static implicit&#160;</td><td class="memItemRight" valign="bottom"><b>operator bool</b> (<a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html">AtomicBoolean</a> atomicBool)</td></tr>
<tr class="separator:a18c7dc277fcf1a3be019bc400c930f29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5bbbcebd0480b65976dfbce614c0f1d5"><td class="memItemLeft" align="right" valign="top"><a id="a5bbbcebd0480b65976dfbce614c0f1d5"></a>
static implicit&#160;</td><td class="memItemRight" valign="bottom"><b>operator AtomicBoolean</b> (bool value)</td></tr>
<tr class="separator:a5bbbcebd0480b65976dfbce614c0f1d5"><td class="memSeparator" colspan="2">&#160;</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:a797abaa3f35ea2016499843b8ddd65c2"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#a797abaa3f35ea2016499843b8ddd65c2">Value</a><code> [get]</code></td></tr>
<tr class="memdesc:a797abaa3f35ea2016499843b8ddd65c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Read the value of the boolean atomically and return it. <a href="classApache_1_1Qpid_1_1Proton_1_1Client_1_1Concurrent_1_1AtomicBoolean.html#a797abaa3f35ea2016499843b8ddd65c2">More...</a><br /></td></tr>
<tr class="separator:a797abaa3f35ea2016499843b8ddd65c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides a boolean value that may be updated and read atomically. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a09f00d9ebc13caa8d2b6e91c2a823925"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a09f00d9ebc13caa8d2b6e91c2a823925">&#9670;&nbsp;</a></span>AtomicBoolean()</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.AtomicBoolean.AtomicBoolean </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>initialValue</em> = <code>false</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>Creates a new atomic boolean instance with either the given value or defaults to false. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">initialValue</td><td>The initial value to provide to the boolean</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a716a9490882fda76c4a23d0589bb8130"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a716a9490882fda76c4a23d0589bb8130">&#9670;&nbsp;</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.AtomicBoolean.CompareAndSet </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>expect</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>update</em>&#160;</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="aacde1fc5076cf5e36dd32bff47692415"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aacde1fc5076cf5e36dd32bff47692415">&#9670;&nbsp;</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">bool Apache.Qpid.Proton.Client.Concurrent.AtomicBoolean.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 boolean atomically and returns it. </p>
<dl class="section return"><dt>Returns</dt><dd>The value of the boolean</dd></dl>
</div>
</div>
<a id="a452329bfe13fcf2346f2a71fc5f25992"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a452329bfe13fcf2346f2a71fc5f25992">&#9670;&nbsp;</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.AtomicBoolean.Set </td>
<td>(</td>
<td class="paramtype">bool&#160;</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 boolean 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 boolean</td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a797abaa3f35ea2016499843b8ddd65c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a797abaa3f35ea2016499843b8ddd65c2">&#9670;&nbsp;</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">bool Apache.Qpid.Proton.Client.Concurrent.AtomicBoolean.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 boolean 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/AtomicBoolean.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>