blob: fae5b60fbc6cc81e3f9fdbf6179a7aad5dd97a1e [file] [log] [blame]
<!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>
<link rel="canonical" href="https://ignite.apache.org/releases/1.8.0/dotnetdoc/interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<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.9.1"/>
<title>Apache Ignite.NET: Apache.Ignite.Core.DataStructures.IAtomicSequence Interface 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></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="projectlogo"><img alt="Logo" src="ignite_logo.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Apache Ignite.NET
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Ignite.Core.DataStructures.IAtomicSequence Interface Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents a distributed atomic sequence of numbers.
<a href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.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:a916f2f08ea46009a6c2e4f7dbb6dba88"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html#a916f2f08ea46009a6c2e4f7dbb6dba88">Read</a> ()</td></tr>
<tr class="memdesc:a916f2f08ea46009a6c2e4f7dbb6dba88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns current value. <a href="#a916f2f08ea46009a6c2e4f7dbb6dba88">More...</a><br /></td></tr>
<tr class="separator:a916f2f08ea46009a6c2e4f7dbb6dba88"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a491c804d78020eaf6fd99d89db525566"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html#a491c804d78020eaf6fd99d89db525566">Increment</a> ()</td></tr>
<tr class="memdesc:a491c804d78020eaf6fd99d89db525566"><td class="mdescLeft">&#160;</td><td class="mdescRight">Increments current value and returns result. <a href="#a491c804d78020eaf6fd99d89db525566">More...</a><br /></td></tr>
<tr class="separator:a491c804d78020eaf6fd99d89db525566"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a702cb93a3af16b172d8f12683bdbcad3"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html#a702cb93a3af16b172d8f12683bdbcad3">Add</a> (long value)</td></tr>
<tr class="memdesc:a702cb93a3af16b172d8f12683bdbcad3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds specified value to the current value and returns result. <a href="#a702cb93a3af16b172d8f12683bdbcad3">More...</a><br /></td></tr>
<tr class="separator:a702cb93a3af16b172d8f12683bdbcad3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a131e8f0f2e0e0e53a7df2dcf45b25a72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html#a131e8f0f2e0e0e53a7df2dcf45b25a72">Close</a> ()</td></tr>
<tr class="memdesc:a131e8f0f2e0e0e53a7df2dcf45b25a72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes this instance. <a href="#a131e8f0f2e0e0e53a7df2dcf45b25a72">More...</a><br /></td></tr>
<tr class="separator:a131e8f0f2e0e0e53a7df2dcf45b25a72"><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:a10754a6e3ebd8bd5348852172d0494f5"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html#a10754a6e3ebd8bd5348852172d0494f5">Name</a><code> [get]</code></td></tr>
<tr class="memdesc:a10754a6e3ebd8bd5348852172d0494f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the name of this atomic sequence. <a href="#a10754a6e3ebd8bd5348852172d0494f5">More...</a><br /></td></tr>
<tr class="separator:a10754a6e3ebd8bd5348852172d0494f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac9035cb5f9b2664b7019486b65a7e0be"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html#ac9035cb5f9b2664b7019486b65a7e0be">BatchSize</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ac9035cb5f9b2664b7019486b65a7e0be"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets local batch size for this atomic sequence. <a href="#ac9035cb5f9b2664b7019486b65a7e0be">More...</a><br /></td></tr>
<tr class="separator:ac9035cb5f9b2664b7019486b65a7e0be"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7099dd02744c18717fe1ea868efdcd28"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html#a7099dd02744c18717fe1ea868efdcd28">IsClosed</a><code> [get]</code></td></tr>
<tr class="memdesc:a7099dd02744c18717fe1ea868efdcd28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines whether this instance was removed from cache. <a href="#a7099dd02744c18717fe1ea868efdcd28">More...</a><br /></td></tr>
<tr class="separator:a7099dd02744c18717fe1ea868efdcd28"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"></div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a702cb93a3af16b172d8f12683bdbcad3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Apache.Ignite.Core.DataStructures.IAtomicSequence.Add </td>
<td>(</td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The value to add.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The new value of the atomic sequence.</dd></dl>
</div>
</div>
<a class="anchor" id="a131e8f0f2e0e0e53a7df2dcf45b25a72"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Apache.Ignite.Core.DataStructures.IAtomicSequence.Close </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a491c804d78020eaf6fd99d89db525566"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Apache.Ignite.Core.DataStructures.IAtomicSequence.Increment </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>The new value of the atomic sequence.</dd></dl>
</div>
</div>
<a class="anchor" id="a916f2f08ea46009a6c2e4f7dbb6dba88"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long Apache.Ignite.Core.DataStructures.IAtomicSequence.Read </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Current value of the atomic sequence.</dd></dl>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="ac9035cb5f9b2664b7019486b65a7e0be"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int Apache.Ignite.Core.DataStructures.IAtomicSequence.BatchSize</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>Sequence batch size.</dd></dl>
</div>
</div>
<a class="anchor" id="a7099dd02744c18717fe1ea868efdcd28"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool Apache.Ignite.Core.DataStructures.IAtomicSequence.IsClosed</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>True if this atomic was removed from cache; otherwise, false.</dd></dl>
</div>
</div>
<a class="anchor" id="a10754a6e3ebd8bd5348852172d0494f5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Apache.Ignite.Core.DataStructures.IAtomicSequence.Name</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>Name of this atomic sequence. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespace_apache.html">Apache</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite.html">Ignite</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite_1_1_core.html">Core</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite_1_1_core_1_1_data_structures.html">DataStructures</a></li><li class="navelem"><a class="el" href="interface_apache_1_1_ignite_1_1_core_1_1_data_structures_1_1_i_atomic_sequence.html">IAtomicSequence</a></li>
<li class="footer">Generated on Mon Dec 5 2016 14:37:40 for Apache Ignite.NET by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9.1 </li>
</ul>
</div>
</body>
</html>