Google Git
Sign in
apache / ignite-website / refs/heads/revert-3-syntax-highlighter-replacement / . / releases / 1.8.0 / dotnetdoc / class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html
blob: 7b6b52eee1a1a65739903eded9c861afd0536dd6 [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/class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.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.SwapSpace.File.FileSwapSpaceSpi 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="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('class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>File-based swap space SPI implementation which holds keys in memory and values on disk. It is intended for cases when value is bigger than 100 bytes, otherwise it will not have any positive effect.
<a href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi:</div>
<div class="dyncontent">
<div class="center">
<img src="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.png" usemap="#Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi_map" alt=""/>
<map id="Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi_map" name="Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi_map">
<area href="interface_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_i_swap_space_spi.html" title="Provides a mechanism in grid for storing data on disk. Ignite cache uses swap space to overflow data ..." alt="Apache.Ignite.Core.SwapSpace.ISwapSpaceSpi" shape="rect" coords="0,0,328,24"/>
</map>
</div></div>
<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:a1f262c956378fba70e1699b6813b3ba3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a1f262c956378fba70e1699b6813b3ba3">FileSwapSpaceSpi</a> ()</td></tr>
<tr class="memdesc:a1f262c956378fba70e1699b6813b3ba3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes a new instance of the <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html" title="File-based swap space SPI implementation which holds keys in memory and values on disk...">FileSwapSpaceSpi</a> class. <a href="#a1f262c956378fba70e1699b6813b3ba3">More...</a><br /></td></tr>
<tr class="separator:a1f262c956378fba70e1699b6813b3ba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:aae51cf7c3662a84b093d4e060b496d53"><td class="memItemLeft" align="right" valign="top">const float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#aae51cf7c3662a84b093d4e060b496d53">DefaultMaximumSparsity</a> = 0.5f</td></tr>
<tr class="memdesc:aae51cf7c3662a84b093d4e060b496d53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value for <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a8b98702071ef7b317d77eddff437cf82" title="Gets or sets the maximum sparsity. This property defines maximum acceptable wasted file space to whol...">MaximumSparsity</a> property. <a href="#aae51cf7c3662a84b093d4e060b496d53">More...</a><br /></td></tr>
<tr class="separator:aae51cf7c3662a84b093d4e060b496d53"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7cac2dc0d337d4229659cc6b8f55127d"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a7cac2dc0d337d4229659cc6b8f55127d">DefaultWriteBufferSize</a> = 64 * 1024</td></tr>
<tr class="memdesc:a7cac2dc0d337d4229659cc6b8f55127d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value for <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a002afa882b8bab0ab93461143232213b" title="Gets or sets the size of the write buffer, in bytes. Write to disk occurs only when this buffer is fu...">WriteBufferSize</a> property. <a href="#a7cac2dc0d337d4229659cc6b8f55127d">More...</a><br /></td></tr>
<tr class="separator:a7cac2dc0d337d4229659cc6b8f55127d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a41f9fc5cdfe2d69ed55b457167cb2a86"><td class="memItemLeft" align="right" valign="top">const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a41f9fc5cdfe2d69ed55b457167cb2a86">DefaultMaximumWriteQueueSize</a> = 1024 * 1024</td></tr>
<tr class="memdesc:a41f9fc5cdfe2d69ed55b457167cb2a86"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value for <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a7333ff4acd38db19bee036b671c73ac4" title="Gets or sets the maximum size of the write queue in bytes. If there are more values are waiting to be...">MaximumWriteQueueSize</a> property. <a href="#a41f9fc5cdfe2d69ed55b457167cb2a86">More...</a><br /></td></tr>
<tr class="separator:a41f9fc5cdfe2d69ed55b457167cb2a86"><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-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:a83392893acfde7a02b8ed3463c43e0c7"><td class="memItemLeft" align="right" valign="top">static readonly int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a83392893acfde7a02b8ed3463c43e0c7">DefaultReadStripesNumber</a> = Environment.ProcessorCount</td></tr>
<tr class="memdesc:a83392893acfde7a02b8ed3463c43e0c7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default value for <a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#ac1cc9d2604c5281b61dbcc47335f8fdf" title="Gets or sets the read stripes number. Defines number of file channels to be used concurrently. Default is Environment.ProcessorCount. ">ReadStripesNumber</a> property. <a href="#a83392893acfde7a02b8ed3463c43e0c7">More...</a><br /></td></tr>
<tr class="separator:a83392893acfde7a02b8ed3463c43e0c7"><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:a5b9412c28f5d8a4f2b501c0af5b736ab"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a5b9412c28f5d8a4f2b501c0af5b736ab">BaseDirectory</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a5b9412c28f5d8a4f2b501c0af5b736ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the base directory. <a href="#a5b9412c28f5d8a4f2b501c0af5b736ab">More...</a><br /></td></tr>
<tr class="separator:a5b9412c28f5d8a4f2b501c0af5b736ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b98702071ef7b317d77eddff437cf82"><td class="memItemLeft" align="right" valign="top">float&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a8b98702071ef7b317d77eddff437cf82">MaximumSparsity</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a8b98702071ef7b317d77eddff437cf82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the maximum sparsity. This property defines maximum acceptable wasted file space to whole file size ratio. When this ratio becomes higher than specified number compacting thread starts working. <a href="#a8b98702071ef7b317d77eddff437cf82">More...</a><br /></td></tr>
<tr class="separator:a8b98702071ef7b317d77eddff437cf82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7333ff4acd38db19bee036b671c73ac4"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a7333ff4acd38db19bee036b671c73ac4">MaximumWriteQueueSize</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a7333ff4acd38db19bee036b671c73ac4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the maximum size of the write queue in bytes. If there are more values are waiting to be written to disk then specified size, SPI will block on write operation. <a href="#a7333ff4acd38db19bee036b671c73ac4">More...</a><br /></td></tr>
<tr class="separator:a7333ff4acd38db19bee036b671c73ac4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac1cc9d2604c5281b61dbcc47335f8fdf"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#ac1cc9d2604c5281b61dbcc47335f8fdf">ReadStripesNumber</a><code> [get, set]</code></td></tr>
<tr class="memdesc:ac1cc9d2604c5281b61dbcc47335f8fdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the read stripes number. Defines number of file channels to be used concurrently. Default is Environment.ProcessorCount. <a href="#ac1cc9d2604c5281b61dbcc47335f8fdf">More...</a><br /></td></tr>
<tr class="separator:ac1cc9d2604c5281b61dbcc47335f8fdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a002afa882b8bab0ab93461143232213b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html#a002afa882b8bab0ab93461143232213b">WriteBufferSize</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a002afa882b8bab0ab93461143232213b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the size of the write buffer, in bytes. Write to disk occurs only when this buffer is full. <a href="#a002afa882b8bab0ab93461143232213b">More...</a><br /></td></tr>
<tr class="separator:a002afa882b8bab0ab93461143232213b"><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">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a1f262c956378fba70e1699b6813b3ba3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi.FileSwapSpaceSpi </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="aae51cf7c3662a84b093d4e060b496d53"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const float Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi.DefaultMaximumSparsity = 0.5f</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a41f9fc5cdfe2d69ed55b457167cb2a86"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi.DefaultMaximumWriteQueueSize = 1024 * 1024</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a83392893acfde7a02b8ed3463c43e0c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly int Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi.DefaultReadStripesNumber = Environment.ProcessorCount</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a7cac2dc0d337d4229659cc6b8f55127d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const int Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi.DefaultWriteBufferSize = 64 * 1024</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a5b9412c28f5d8a4f2b501c0af5b736ab"></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.SwapSpace.File.FileSwapSpaceSpi.BaseDirectory</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">
</div>
</div>
<a class="anchor" id="a8b98702071ef7b317d77eddff437cf82"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">float Apache.Ignite.Core.SwapSpace.File.FileSwapSpaceSpi.MaximumSparsity</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">
<p>The maximum sparsity. Must be between 0 and 1. </p>
</div>
</div>
<a class="anchor" id="a7333ff4acd38db19bee036b671c73ac4"></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.SwapSpace.File.FileSwapSpaceSpi.MaximumWriteQueueSize</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">
<p>The maximum size of the write queue, in bytes. </p>
</div>
</div>
<a class="anchor" id="ac1cc9d2604c5281b61dbcc47335f8fdf"></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.SwapSpace.File.FileSwapSpaceSpi.ReadStripesNumber</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">
<p>Number of read stripes. </p>
</div>
</div>
<a class="anchor" id="a002afa882b8bab0ab93461143232213b"></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.SwapSpace.File.FileSwapSpaceSpi.WriteBufferSize</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">
<p>The size of the write buffer, in bytes. </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_swap_space.html">SwapSpace</a></li><li class="navelem"><a class="el" href="namespace_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file.html">File</a></li><li class="navelem"><a class="el" href="class_apache_1_1_ignite_1_1_core_1_1_swap_space_1_1_file_1_1_file_swap_space_spi.html">FileSwapSpaceSpi</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>