| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/releases/2.6.0/javadoc/org/apache/ignite/configuration/MemoryPolicyConfiguration.html" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
| |
| <!-- Generated by javadoc (1.8.0_77) on Tue Jul 10 11:04:45 UTC 2018 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MemoryPolicyConfiguration (Ignite 2.6.0)</title> |
| <meta name="date" content="2018-07-10"> |
| <link rel="stylesheet" type="text/css" href="../../../../javadoc.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| |
| <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> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MemoryPolicyConfiguration (Ignite 2.6.0)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":42,"i1":42,"i2":42,"i3":42,"i4":42,"i5":42,"i6":42,"i7":42,"i8":42,"i9":42,"i10":42,"i11":42,"i12":42,"i13":42,"i14":42,"i15":42,"i16":42,"i17":42,"i18":42,"i19":42}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MemoryPolicyConfiguration.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">Ignite - In-Memory Data Fabric</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/ignite/configuration/MemoryConfiguration.html" title="class in org.apache.ignite.configuration"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/configuration/NearCacheConfiguration.html" title="class in org.apache.ignite.configuration"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/configuration/MemoryPolicyConfiguration.html" target="_top">Frames</a></li> |
| <li><a href="MemoryPolicyConfiguration.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.ignite.configuration</div> |
| <h2 title="Class MemoryPolicyConfiguration" class="title">Class MemoryPolicyConfiguration</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.ignite.configuration.MemoryPolicyConfiguration</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd> |
| </dl> |
| <hr> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> |
| <div class="block"><span class="deprecationComment">Use <a href="../../../../org/apache/ignite/configuration/DataRegionConfiguration.html" title="class in org.apache.ignite.configuration"><code>DataRegionConfiguration</code></a> instead.</span></div> |
| </div> |
| <br> |
| <pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> |
| public final class <span class="typeNameLabel">MemoryPolicyConfiguration</span> |
| extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre> |
| <div class="block">This class allows defining custom memory policies' configurations with various parameters for Apache Ignite |
| page memory (see <a href="../../../../org/apache/ignite/configuration/MemoryConfiguration.html" title="class in org.apache.ignite.configuration"><code>MemoryConfiguration</code></a>. For each configured memory policy Apache Ignite instantiates |
| respective memory regions with different parameters like maximum size, eviction policy, swapping options, etc. |
| An Apache Ignite cache can be mapped to a particular policy using |
| <a href="../../../../org/apache/ignite/configuration/CacheConfiguration.html#setMemoryPolicyName-java.lang.String-"><code>CacheConfiguration.setMemoryPolicyName(String)</code></a> method. |
| <p>Sample configuration below shows how to configure several memory policies:</p> |
| <pre> |
| <code> |
| <property name="memoryConfiguration"> |
| <bean class="org.apache.ignite.configuration.MemoryConfiguration"> |
| <property name="defaultMemoryPolicyName" value="Default_Region"/> |
| <property name="pageSize" value="4096"/> |
| |
| <property name="memoryPolicies"> |
| <list> |
| <bean class="org.apache.ignite.configuration.MemoryPolicyConfiguration"> |
| <property name="name" value="Default_Region"/> |
| <property name="initialSize" value="#{100 * 1024 * 1024}"/> |
| </bean> |
| |
| <bean class="org.apache.ignite.configuration.MemoryPolicyConfiguration"> |
| <property name="name" value="20MB_Region_Eviction"/> |
| <property name="initialSize" value="#{20 * 1024 * 1024}"/> |
| <property name="pageEvictionMode" value="RANDOM_2_LRU"/> |
| </bean> |
| |
| <bean class="org.apache.ignite.configuration.MemoryPolicyConfiguration"> |
| <property name="name" value="25MB_Region_Swapping"/> |
| <property name="initialSize" value="#{25 * 1024 * 1024}"/> |
| <property name="initialSize" value="#{100 * 1024 * 1024}"/> |
| <property name="swapFilePath" value="memoryPolicyExampleSwap"/> |
| </bean> |
| </list> |
| </property> |
| </code> |
| </pre></div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../serialized-form.html#org.apache.ignite.configuration.MemoryPolicyConfiguration">Serialized Form</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#DFLT_METRICS_ENABLED">DFLT_METRICS_ENABLED</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Default metrics enabled flag.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#DFLT_RATE_TIME_INTERVAL_MILLIS">DFLT_RATE_TIME_INTERVAL_MILLIS</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Default length of interval over which <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> metric is calculated.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#DFLT_SUB_INTERVALS">DFLT_SUB_INTERVALS</a></span></code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Default amount of sub intervals to calculate <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> metric.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#MemoryPolicyConfiguration--">MemoryPolicyConfiguration</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getEmptyPagesPoolSize--">getEmptyPagesPoolSize</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Specifies the minimal number of empty pages to be present in reuse lists for this memory policy.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getEvictionThreshold--">getEvictionThreshold</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets a threshold for memory pages eviction initiation.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getInitialSize--">getInitialSize</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets initial memory region size defined by this memory policy.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getMaxSize--">getMaxSize</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Maximum memory region size defined by this memory policy.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getName--">getName</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets memory policy name.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration">DataPageEvictionMode</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getPageEvictionMode--">getPageEvictionMode</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets memory pages eviction mode.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getRateTimeInterval--">getRateTimeInterval</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets time interval for <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> |
| and <a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--"><code>MemoryMetrics.getEvictionRate()</code></a> monitoring purposes.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getSubIntervals--">getSubIntervals</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setRateTimeInterval-long-"><code>setRateTimeInterval(long)</code></a> |
| will be split into to calculate <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> |
| and <a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--"><code>MemoryMetrics.getEvictionRate()</code></a> rates (5 by default).</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getSwapFilePath--">getSwapFilePath</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">A path to the memory-mapped files the memory region defined by this memory policy will be mapped to.</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#isMetricsEnabled--">isMetricsEnabled</a></span>()</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets whether memory metrics are enabled by default on node startup.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setEmptyPagesPoolSize-int-">setEmptyPagesPoolSize</a></span>(int emptyPagesPoolSize)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Specifies the minimal number of empty pages to be present in reuse lists for this memory policy.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setEvictionThreshold-double-">setEvictionThreshold</a></span>(double evictionThreshold)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets memory pages eviction threshold.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setInitialSize-long-">setInitialSize</a></span>(long initialSize)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets initial memory region size defined by this memory policy.</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setMaxSize-long-">setMaxSize</a></span>(long maxSize)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets maximum memory region size defined by this memory policy.</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setMetricsEnabled-boolean-">setMetricsEnabled</a></span>(boolean metricsEnabled)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets memory metrics enabled flag.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setName-java.lang.String-">setName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets memory policy name.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setPageEvictionMode-org.apache.ignite.configuration.DataPageEvictionMode-">setPageEvictionMode</a></span>(<a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration">DataPageEvictionMode</a> evictionMode)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets memory pages eviction mode.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setRateTimeInterval-long-">setRateTimeInterval</a></span>(long rateTimeInterval)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets time interval for <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> |
| and <a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--"><code>MemoryMetrics.getEvictionRate()</code></a> monitoring purposes.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setSubIntervals-int-">setSubIntervals</a></span>(int subIntervals)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setRateTimeInterval-long-"><code>setRateTimeInterval(long)</code></a> will be split into to calculate |
| <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--"><code>MemoryMetrics.getEvictionRate()</code></a> rates (5 by default).</div> |
| </td> |
| </tr> |
| <tr id="i19" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setSwapFilePath-java.lang.String-">setSwapFilePath</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> swapFilePath)</code> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets a path to the memory-mapped file.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="DFLT_METRICS_ENABLED"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DFLT_METRICS_ENABLED</h4> |
| <pre>public static final boolean DFLT_METRICS_ENABLED</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Default metrics enabled flag.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.ignite.configuration.MemoryPolicyConfiguration.DFLT_METRICS_ENABLED">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DFLT_SUB_INTERVALS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>DFLT_SUB_INTERVALS</h4> |
| <pre>public static final int DFLT_SUB_INTERVALS</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Default amount of sub intervals to calculate <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> metric.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.ignite.configuration.MemoryPolicyConfiguration.DFLT_SUB_INTERVALS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="DFLT_RATE_TIME_INTERVAL_MILLIS"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>DFLT_RATE_TIME_INTERVAL_MILLIS</h4> |
| <pre>public static final int DFLT_RATE_TIME_INTERVAL_MILLIS</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Default length of interval over which <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> metric is calculated.</div> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../constant-values.html#org.apache.ignite.configuration.MemoryPolicyConfiguration.DFLT_RATE_TIME_INTERVAL_MILLIS">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="MemoryPolicyConfiguration--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>MemoryPolicyConfiguration</h4> |
| <pre>public MemoryPolicyConfiguration()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets memory policy name.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Memory policy name.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setName-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setName</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setName(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets memory policy name. The name must be non empty and must not be equal to the reserved 'sysMemPlc' one. |
| |
| If not specified, <a href="../../../../org/apache/ignite/configuration/MemoryConfiguration.html#DFLT_MEM_PLC_DEFAULT_NAME"><code>MemoryConfiguration.DFLT_MEM_PLC_DEFAULT_NAME</code></a> value is used.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>name</code> - Memory policy name.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxSize</h4> |
| <pre>public long getMaxSize()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Maximum memory region size defined by this memory policy. If the whole data can not fit into the memory region |
| an out of memory exception will be thrown.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Size in bytes.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMaxSize-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMaxSize</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setMaxSize(long maxSize)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets maximum memory region size defined by this memory policy. The total size should not be less than 10 MB |
| due to the internal data structures overhead.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>maxSize</code> - Maximum memory policy size in bytes.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getInitialSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getInitialSize</h4> |
| <pre>public long getInitialSize()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets initial memory region size defined by this memory policy. When the used memory size exceeds this value, |
| new chunks of memory will be allocated.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Memory policy start size.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setInitialSize-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setInitialSize</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setInitialSize(long initialSize)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets initial memory region size defined by this memory policy. When the used memory size exceeds this value, |
| new chunks of memory will be allocated.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>initialSize</code> - Memory policy initial size.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSwapFilePath--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSwapFilePath</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getSwapFilePath()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">A path to the memory-mapped files the memory region defined by this memory policy will be mapped to. Having |
| the path set, allows relying on swapping capabilities of an underlying operating system for the memory region.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>A path to the memory-mapped files or <code>null</code> if this feature is not used for the memory region |
| defined by this memory policy.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSwapFilePath-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSwapFilePath</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setSwapFilePath(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> swapFilePath)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets a path to the memory-mapped file.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>swapFilePath</code> - A Path to the memory mapped file.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPageEvictionMode--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPageEvictionMode</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration">DataPageEvictionMode</a> getPageEvictionMode()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets memory pages eviction mode. If <a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html#DISABLED"><code>DataPageEvictionMode.DISABLED</code></a> is used (default) then an out of |
| memory exception will be thrown if the memory region usage, defined by this memory policy, goes beyond its |
| capacity which is <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#getMaxSize--"><code>getMaxSize()</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Memory pages eviction algorithm. <a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html#DISABLED"><code>DataPageEvictionMode.DISABLED</code></a> used by default.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPageEvictionMode-org.apache.ignite.configuration.DataPageEvictionMode-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPageEvictionMode</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setPageEvictionMode(<a href="../../../../org/apache/ignite/configuration/DataPageEvictionMode.html" title="enum in org.apache.ignite.configuration">DataPageEvictionMode</a> evictionMode)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets memory pages eviction mode.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>evictionMode</code> - Eviction mode.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEvictionThreshold--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEvictionThreshold</h4> |
| <pre>public double getEvictionThreshold()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets a threshold for memory pages eviction initiation. For instance, if the threshold is 0.9 it means that the |
| page memory will start the eviction only after 90% of the memory region (defined by this policy) is occupied.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Memory pages eviction threshold.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEvictionThreshold-double-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEvictionThreshold</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setEvictionThreshold(double evictionThreshold)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets memory pages eviction threshold.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>evictionThreshold</code> - Eviction threshold.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getEmptyPagesPoolSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getEmptyPagesPoolSize</h4> |
| <pre>public int getEmptyPagesPoolSize()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Specifies the minimal number of empty pages to be present in reuse lists for this memory policy. |
| This parameter ensures that Ignite will be able to successfully evict old data entries when the size of |
| (key, value) pair is slightly larger than page size / 2. |
| Increase this parameter if cache can contain very big entries (total size of pages in this pool should be enough |
| to contain largest cache entry). |
| Increase this parameter if <code>IgniteOutOfMemoryException</code> occurred with enabled page eviction.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Minimum number of empty pages in reuse list.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setEmptyPagesPoolSize-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setEmptyPagesPoolSize</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setEmptyPagesPoolSize(int emptyPagesPoolSize)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Specifies the minimal number of empty pages to be present in reuse lists for this memory policy. |
| This parameter ensures that Ignite will be able to successfully evict old data entries when the size of |
| (key, value) pair is slightly larger than page size / 2. |
| Increase this parameter if cache can contain very big entries (total size of pages in this pool should be enough |
| to contain largest cache entry). |
| Increase this parameter if <code>IgniteOutOfMemoryException</code> occurred with enabled page eviction.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>emptyPagesPoolSize</code> - Empty pages pool size.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="isMetricsEnabled--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isMetricsEnabled</h4> |
| <pre>public boolean isMetricsEnabled()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets whether memory metrics are enabled by default on node startup. Memory metrics can be enabled and disabled |
| at runtime via memory metrics <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><code>MX bean</code></a>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Metrics enabled flag.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setMetricsEnabled-boolean-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setMetricsEnabled</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setMetricsEnabled(boolean metricsEnabled)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets memory metrics enabled flag. If this flag is <code>true</code>, metrics will be enabled on node startup. |
| Memory metrics can be enabled and disabled at runtime via memory metrics <a href="../../../../org/apache/ignite/mxbean/DataRegionMetricsMXBean.html" title="interface in org.apache.ignite.mxbean"><code>MX bean</code></a>.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>metricsEnabled</code> - Metrics enabled flag.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRateTimeInterval--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getRateTimeInterval</h4> |
| <pre>public long getRateTimeInterval()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets time interval for <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> |
| and <a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--"><code>MemoryMetrics.getEvictionRate()</code></a> monitoring purposes. |
| <p> |
| For instance, after setting the interval to 60_000 milliseconds, |
| subsequent calls to <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> |
| will return average allocation rate (pages per second) for the last minute.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Time interval over which allocation rate is calculated.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setRateTimeInterval-long-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setRateTimeInterval</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setRateTimeInterval(long rateTimeInterval)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets time interval for <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> |
| and <a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--"><code>MemoryMetrics.getEvictionRate()</code></a> monitoring purposes. |
| <p> |
| For instance, after setting the interval to 60 seconds, |
| subsequent calls to <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> |
| will return average allocation rate (pages per second) for the last minute.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>rateTimeInterval</code> - Time interval used for allocation and eviction rates calculations.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getSubIntervals--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSubIntervals</h4> |
| <pre>public int getSubIntervals()</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Gets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setRateTimeInterval-long-"><code>setRateTimeInterval(long)</code></a> |
| will be split into to calculate <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> |
| and <a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--"><code>MemoryMetrics.getEvictionRate()</code></a> rates (5 by default). |
| <p> |
| Setting it to a bigger value will result in more precise calculation and smaller drops of |
| <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> metric when next sub-interval has to be recycled but introduces bigger |
| calculation overhead.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>number of sub intervals.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setSubIntervals-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setSubIntervals</h4> |
| <pre>public <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html" title="class in org.apache.ignite.configuration">MemoryPolicyConfiguration</a> setSubIntervals(int subIntervals)</pre> |
| <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> |
| <div class="block">Sets a number of sub-intervals the whole <a href="../../../../org/apache/ignite/configuration/MemoryPolicyConfiguration.html#setRateTimeInterval-long-"><code>setRateTimeInterval(long)</code></a> will be split into to calculate |
| <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> and <a href="../../../../org/apache/ignite/MemoryMetrics.html#getEvictionRate--"><code>MemoryMetrics.getEvictionRate()</code></a> rates (5 by default). |
| <p> |
| Setting it to a bigger value will result in more precise calculation and smaller drops of |
| <a href="../../../../org/apache/ignite/MemoryMetrics.html#getAllocationRate--"><code>MemoryMetrics.getAllocationRate()</code></a> metric when next sub-interval has to be recycled but introduces bigger |
| calculation overhead.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subIntervals</code> - A number of sub-intervals.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>this</code> for chaining.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MemoryPolicyConfiguration.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage">Ignite - In-Memory Data Fabric</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/ignite/configuration/MemoryConfiguration.html" title="class in org.apache.ignite.configuration"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/ignite/configuration/NearCacheConfiguration.html" title="class in org.apache.ignite.configuration"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/ignite/configuration/MemoryPolicyConfiguration.html" target="_top">Frames</a></li> |
| <li><a href="MemoryPolicyConfiguration.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field.summary">Field</a> | </li> |
| <li><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><table width="100%" border="0" cellspacing=0 cellpadding=0 style="padding: 5px"> <tr> <td> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <a target=_blank href="https://ignite.apache.org"><nobr>2018 Copyright © Apache Software Foundation</nobr></a> </td> </tr> </tbody> </table> </td> <td width="100%" align="right" valign="center"> <a href="https://twitter.com/ApacheIgnite" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ApacheIgnite</a> </td> </tr> <tr> <td colspan="2" valign="top" align="left"> <table style="padding-left: 0; margin: 0"> <tbody style="padding: 0; margin: 0"> <tr style="padding: 0; margin: 0"> <td> <b>Ignite Fabric</b> </td> <td>: ver. <strong>2.6.0</strong> </td> </tr> <tr style="padding: 0; margin: 0"> <td> <b>Release Date</b> </td> <td>: July 10 2018 </td> </tr> </tbody> </table> </td> </tr> </table></small></p> |
| </body> |
| </html> |