| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>DiskStore (Apache Geode 1.15.1)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="DiskStore (Apache Geode 1.15.1)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/cache/DiskAccessException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/cache/DiskStore.html" target="_top">Frames</a></li> |
| <li><a href="DiskStore.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.geode.cache</div> |
| <h2 title="Interface DiskStore" class="title">Interface DiskStore</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">DiskStore</span></pre> |
| <div class="block">Provides disk storage for one or more regions. The regions in the same disk store will share the |
| same disk persistence attributes. A region without a disk store name belongs to the default disk |
| store. |
| <p> |
| Instances of this interface are created using <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#create-java.lang.String-"><code>DiskStoreFactory.create(java.lang.String)</code></a>. So to create a |
| <code>DiskStore</code> named <code>myDiskStore</code> do this: |
| |
| <PRE> |
| new DiskStoreFactory().create("myDiskStore"); |
| </PRE> |
| <p> |
| Existing DiskStore instances can be found using <a href="../../../../org/apache/geode/cache/GemFireCache.html#findDiskStore-java.lang.String-"><code>GemFireCache.findDiskStore(String)</code></a></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 6.5</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#destroy--">destroy</a></span>()</code> |
| <div class="block">Destroys this disk store.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#flush--">flush</a></span>()</code> |
| <div class="block">Causes any data that is currently in the asynchronous queue to be written to disk.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#forceCompaction--">forceCompaction</a></span>()</code> |
| <div class="block">Allows a disk compaction to be forced on this disk store.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#forceRoll--">forceRoll</a></span>()</code> |
| <div class="block">Asks the disk store to start writing to a new oplog.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getAllowForceCompaction--">getAllowForceCompaction</a></span>()</code> |
| <div class="block">Returns true if manual compaction of disk files is allowed on this region.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getAutoCompact--">getAutoCompact</a></span>()</code> |
| <div class="block">Returns true if the disk files are to be automatically compacted.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getCompactionThreshold--">getCompactionThreshold</a></span>()</code> |
| <div class="block">Returns the threshold at which an oplog will become compactable.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskDirs--">getDiskDirs</a></span>()</code> |
| <div class="block">Returns the directories to which the region's data are written.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskDirSizes--">getDiskDirSizes</a></span>()</code> |
| <div class="block">Returns the sizes of the disk directories in megabytes</div> |
| </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskStoreUUID--">getDiskStoreUUID</a></span>()</code> |
| <div class="block">Returns the universally unique identifier for the Disk Store across the GemFire distributed |
| system.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskUsageCriticalPercentage--">getDiskUsageCriticalPercentage</a></span>()</code> |
| <div class="block">Returns the critical threshold for disk usage as a percentage of the total disk volume.</div> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>float</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getDiskUsageWarningPercentage--">getDiskUsageWarningPercentage</a></span>()</code> |
| <div class="block">Returns the warning threshold for disk usage as a percentage of the total disk volume.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getMaxOplogSize--">getMaxOplogSize</a></span>()</code> |
| <div class="block">Get the maximum size in megabytes a single oplog (operation log) file should be</div> |
| </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code><a href="https://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/geode/cache/DiskStore.html#getName--">getName</a></span>()</code> |
| <div class="block">Get the name of the DiskStore</div> |
| </td> |
| </tr> |
| <tr id="i14" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getQueueSize--">getQueueSize</a></span>()</code> |
| <div class="block">Returns the maximum number of operations that can be asynchronously queued to be written to |
| disk.</div> |
| </td> |
| </tr> |
| <tr id="i15" class="rowColor"> |
| <td class="colFirst"><code>long</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getTimeInterval--">getTimeInterval</a></span>()</code> |
| <div class="block">Returns the number of milliseconds that can elapse before unwritten data is written to disk.</div> |
| </td> |
| </tr> |
| <tr id="i16" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#getWriteBufferSize--">getWriteBufferSize</a></span>()</code> |
| <div class="block">Returns the size of the write buffer that this disk store will use when writing data to disk.</div> |
| </td> |
| </tr> |
| <tr id="i17" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#setDiskUsageCriticalPercentage-float-">setDiskUsageCriticalPercentage</a></span>(float criticalPercent)</code> |
| <div class="block">Sets the value of the disk usage critical percentage.</div> |
| </td> |
| </tr> |
| <tr id="i18" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStore.html#setDiskUsageWarningPercentage-float-">setDiskUsageWarningPercentage</a></span>(float warningPercent)</code> |
| <div class="block">Sets the value of the disk usage warning percentage.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ 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><a href="https://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">Get the name of the DiskStore</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the name of the DiskStore</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#create-java.lang.String-"><code>DiskStoreFactory.create(java.lang.String)</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAutoCompact--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAutoCompact</h4> |
| <pre>boolean getAutoCompact()</pre> |
| <div class="block">Returns true if the disk files are to be automatically compacted.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns true if the disk files are to be automatically compacted; false if automatic |
| compaction is turned off</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCompactionThreshold--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCompactionThreshold</h4> |
| <pre>int getCompactionThreshold()</pre> |
| <div class="block">Returns the threshold at which an oplog will become compactable. Until it reaches this |
| threshold the oplog will not be compacted. The threshold is a percentage in the range 0..100.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the threshold, as a percentage, at which an oplog is considered compactable.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getAllowForceCompaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getAllowForceCompaction</h4> |
| <pre>boolean getAllowForceCompaction()</pre> |
| <div class="block">Returns true if manual compaction of disk files is allowed on this region. Manual compaction is |
| done be calling <a href="../../../../org/apache/geode/cache/DiskStore.html#forceCompaction--"><code>forceCompaction()</code></a>. |
| <p> |
| Note that calls to <a href="../../../../org/apache/geode/cache/DiskStore.html#forceCompaction--"><code>forceCompaction()</code></a> will also be allowed if <a href="../../../../org/apache/geode/cache/DiskStore.html#getAutoCompact--"><code>automatic compaction</code></a> is enabled.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns true if manual compaction of disk files is allowed on this region.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getMaxOplogSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getMaxOplogSize</h4> |
| <pre>long getMaxOplogSize()</pre> |
| <div class="block">Get the maximum size in megabytes a single oplog (operation log) file should be</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maximum size in megabyte the operations log file can be</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getTimeInterval--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTimeInterval</h4> |
| <pre>long getTimeInterval()</pre> |
| <div class="block">Returns the number of milliseconds that can elapse before unwritten data is written to disk.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the time interval in milliseconds that can elapse between two writes to disk</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getWriteBufferSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getWriteBufferSize</h4> |
| <pre>int getWriteBufferSize()</pre> |
| <div class="block">Returns the size of the write buffer that this disk store will use when writing data to disk. |
| Larger values may increase performance but will use more memory. The disk store will allocate |
| one direct memory buffer of this size.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Returns the size of the write buffer.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskDirs--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskDirs</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</a>[] getDiskDirs()</pre> |
| <div class="block">Returns the directories to which the region's data are written. If multiple directories are |
| used, GemFire will attempt to distribute the data evenly amongst them.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the directories to which the region's data are written</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskDirSizes--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskDirSizes</h4> |
| <pre>int[] getDiskDirSizes()</pre> |
| <div class="block">Returns the sizes of the disk directories in megabytes</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the sizes of the disk directories in megabytes</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskStoreUUID--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskStoreUUID</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util">UUID</a> getDiskStoreUUID()</pre> |
| <div class="block">Returns the universally unique identifier for the Disk Store across the GemFire distributed |
| system. |
| <p></div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a UUID uniquely identifying this Disk Store in the GemFire distributed system.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="https://docs.oracle.com/javase/8/docs/api/java/util/UUID.html?is-external=true" title="class or interface in java.util"><code>UUID</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getQueueSize--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getQueueSize</h4> |
| <pre>int getQueueSize()</pre> |
| <div class="block">Returns the maximum number of operations that can be asynchronously queued to be written to |
| disk. When this limit is reached, it will cause operations to block until they can be put in |
| the queue. If this <code>DiskStore</code> configures synchronous writing, then |
| <code>queueSize</code> is ignored.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the maxinum number of entries that can be queued concurrently for asynchronous writting |
| to disk.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="flush--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>flush</h4> |
| <pre>void flush()</pre> |
| <div class="block">Causes any data that is currently in the asynchronous queue to be written to disk. Does not |
| return until the flush is complete.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../org/apache/geode/cache/DiskAccessException.html" title="class in org.apache.geode.cache">DiskAccessException</a></code> - If problems are encounter while writing to disk</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="forceRoll--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forceRoll</h4> |
| <pre>void forceRoll()</pre> |
| <div class="block">Asks the disk store to start writing to a new oplog. The old oplog will be asynchronously |
| compressed if compaction is set to true. The new oplog will be created in the next available |
| directory with free space. If there is no directory with free space available and compaction is |
| set to false, then a <code>DiskAccessException</code> saying that the disk is full will be |
| thrown. If compaction is true then the application will wait for the other oplogs to be |
| compacted and more space to be created.</div> |
| </li> |
| </ul> |
| <a name="forceCompaction--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>forceCompaction</h4> |
| <pre>boolean forceCompaction()</pre> |
| <div class="block">Allows a disk compaction to be forced on this disk store. The compaction is done even if |
| automatic compaction is not configured. If the current active oplog has had data written to it |
| and it is compactable then an implicit call to <a href="../../../../org/apache/geode/cache/DiskStore.html#forceRoll--"><code>forceRoll()</code></a> will be made so that the |
| active oplog can be compacted. |
| <P> |
| This method will block until the compaction completes.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>true</code> if one or more oplogs were compacted; <code>false</code> indicates |
| that no oplogs were ready to be compacted or that a compaction was already in progress.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../org/apache/geode/cache/DiskStore.html#getAllowForceCompaction--"><code>getAllowForceCompaction()</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="destroy--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>destroy</h4> |
| <pre>void destroy()</pre> |
| <div class="block">Destroys this disk store. Removes the disk store from the cache, and removes all files related |
| to the disk store from disk. |
| |
| If there are any currently open regions in the disk store this method will throw an exception. |
| If there are any closed regions that are persisted in this disk store, the data for those |
| regions will be destroyed.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if the disk store is currently in use by any regions, gateway |
| senders, or a PDX type registry.</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskUsageWarningPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskUsageWarningPercentage</h4> |
| <pre>float getDiskUsageWarningPercentage()</pre> |
| <div class="block">Returns the warning threshold for disk usage as a percentage of the total disk volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the warning percent</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getDiskUsageCriticalPercentage--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getDiskUsageCriticalPercentage</h4> |
| <pre>float getDiskUsageCriticalPercentage()</pre> |
| <div class="block">Returns the critical threshold for disk usage as a percentage of the total disk volume.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the critical percent</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>GemFire 8.0</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDiskUsageWarningPercentage-float-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDiskUsageWarningPercentage</h4> |
| <pre>void setDiskUsageWarningPercentage(float warningPercent)</pre> |
| <div class="block">Sets the value of the disk usage warning percentage.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>warningPercent</code> - the warning percent</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setDiskUsageCriticalPercentage-float-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>setDiskUsageCriticalPercentage</h4> |
| <pre>void setDiskUsageCriticalPercentage(float criticalPercent)</pre> |
| <div class="block">Sets the value of the disk usage critical percentage.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>criticalPercent</code> - the critical percent</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="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> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../org/apache/geode/cache/DiskAccessException.html" title="class in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/geode/cache/DiskStore.html" target="_top">Frames</a></li> |
| <li><a href="DiskStore.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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |