http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/DiskStore.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/DiskStore.html b/releases/latest/javadoc/org/apache/geode/cache/DiskStore.html new file mode 100644 index 0000000..185a9c9 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/DiskStore.html @@ -0,0 +1,650 @@ +<!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 (1.8.0_45) on Sat Oct 15 16:23:28 PDT 2016 --> +<title>DiskStore (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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 (incubating) 1.0.0-incubating)"; + } + } + 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>java.io.File[]</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>java.util.UUID</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>java.lang.String</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>java.lang.String 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>java.io.File[] 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> +</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> +</li> +</ul> +<a name="getDiskStoreUUID--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDiskStoreUUID</h4> +<pre>java.util.UUID 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><code>UUID</code></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> +<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></dd> +</dl> +</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>java.lang.IllegalStateException</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>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/DiskStoreFactory.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/DiskStoreFactory.html b/releases/latest/javadoc/org/apache/geode/cache/DiskStoreFactory.html new file mode 100644 index 0000000..bb23e8b --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/DiskStoreFactory.html @@ -0,0 +1,809 @@ +<!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 (1.8.0_45) on Sat Oct 15 16:23:28 PDT 2016 --> +<title>DiskStoreFactory (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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="DiskStoreFactory (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + 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}; +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/DiskStore.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/DiskWriteAttributes.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/DiskStoreFactory.html" target="_top">Frames</a></li> +<li><a href="DiskStoreFactory.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>Constr | </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>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 DiskStoreFactory" class="title">Interface DiskStoreFactory</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public interface <span class="typeNameLabel">DiskStoreFactory</span></pre> +<div class="block">Factory for creating instances of <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a>. + To get an instance of this factory call <a href="../../../../org/apache/geode/cache/GemFireCache.html#createDiskStoreFactory--"><code>GemFireCache.createDiskStoreFactory()</code></a>. + If all you want to do is find an existing disk store see <a href="../../../../org/apache/geode/cache/GemFireCache.html#findDiskStore-java.lang.String-"><code>GemFireCache.findDiskStore(java.lang.String)</code></a>. + <P> + To use this factory configure it with the <code>set</code> methods and then + call <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#create-java.lang.String-"><code>create(java.lang.String)</code></a> to produce a disk store instance.</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"> +<!-- =========== 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/geode/cache/DiskStoreFactory.html#DEFAULT_ALLOW_FORCE_COMPACTION">DEFAULT_ALLOW_FORCE_COMPACTION</a></span></code> +<div class="block">The default value of the allow force compaction attribute.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_AUTO_COMPACT">DEFAULT_AUTO_COMPACT</a></span></code> +<div class="block">The default setting for auto compaction.</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/geode/cache/DiskStoreFactory.html#DEFAULT_COMPACTION_THRESHOLD">DEFAULT_COMPACTION_THRESHOLD</a></span></code> +<div class="block">The default compaction threshold.</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/geode/cache/DiskStoreFactory.html#DEFAULT_DISK_DIR_SIZE">DEFAULT_DISK_DIR_SIZE</a></span></code> +<div class="block">The default disk directory size in megabytes.</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/geode/cache/DiskStoreFactory.html#DEFAULT_DISK_DIR_SIZES">DEFAULT_DISK_DIR_SIZES</a></span></code> +<div class="block">The default disk directory sizes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static java.io.File[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_DISK_DIRS">DEFAULT_DISK_DIRS</a></span></code> +<div class="block">The default disk directories.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static java.lang.String</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_DISK_STORE_NAME">DEFAULT_DISK_STORE_NAME</a></span></code> +<div class="block">The name of the default disk store is "DEFAULT".</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_DISK_USAGE_CRITICAL_PERCENTAGE">DEFAULT_DISK_USAGE_CRITICAL_PERCENTAGE</a></span></code> +<div class="block">The default disk usage critical percentage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_DISK_USAGE_WARNING_PERCENTAGE">DEFAULT_DISK_USAGE_WARNING_PERCENTAGE</a></span></code> +<div class="block">The default disk usage warning percentage.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_MAX_OPLOG_SIZE">DEFAULT_MAX_OPLOG_SIZE</a></span></code> +<div class="block">The default maximum oplog file size in megabytes.</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/geode/cache/DiskStoreFactory.html#DEFAULT_QUEUE_SIZE">DEFAULT_QUEUE_SIZE</a></span></code> +<div class="block">The default maximum number of operations that can be asynchronously queued.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_TIME_INTERVAL">DEFAULT_TIME_INTERVAL</a></span></code> +<div class="block">The default time interval in milliseconds.</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/geode/cache/DiskStoreFactory.html#DEFAULT_WRITE_BUFFER_SIZE">DEFAULT_WRITE_BUFFER_SIZE</a></span></code> +<div class="block">The default write buffer size.</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="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><a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache">DiskStore</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#create-java.lang.String-">create</a></span>(java.lang.String name)</code> +<div class="block">Create a new disk store or find an existing one.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setAllowForceCompaction-boolean-">setAllowForceCompaction</a></span>(boolean allowForceCompaction)</code> +<div class="block">Set to <code>true</code> to allow <a href="../../../../org/apache/geode/cache/DiskStore.html#forceCompaction--"><code>DiskStore.forceCompaction()</code></a> to be called + on regions using this disk store.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setAutoCompact-boolean-">setAutoCompact</a></span>(boolean isAutoCompact)</code> +<div class="block">Set to <code>true</code> to cause the disk files to be automatically compacted.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setCompactionThreshold-int-">setCompactionThreshold</a></span>(int compactionThreshold)</code> +<div class="block">Sets the threshold at which an oplog will become compactable.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setDiskDirs-java.io.File:A-">setDiskDirs</a></span>(java.io.File[] diskDirs)</code> +<div class="block">Sets the directories to which this disk store's data is written.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setDiskDirsAndSizes-java.io.File:A-int:A-">setDiskDirsAndSizes</a></span>(java.io.File[] diskDirs, + int[] diskDirSizes)</code> +<div class="block">Sets the directories to which this disk store's data is written + and also set the sizes in megabytes of each directory.</div> +</td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setDiskUsageCriticalPercentage-float-">setDiskUsageCriticalPercentage</a></span>(float criticalPercent)</code> +<div class="block">Sets the critical threshold for disk usage as a percentage of the total disk + volume.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setDiskUsageWarningPercentage-float-">setDiskUsageWarningPercentage</a></span>(float warningPercent)</code> +<div class="block">Sets the warning threshold for disk usage as a percentage of the total disk + volume.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setMaxOplogSize-long-">setMaxOplogSize</a></span>(long maxOplogSize)</code> +<div class="block">Sets the maximum size in megabytes a single oplog (operation log) is allowed to be.</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setQueueSize-int-">setQueueSize</a></span>(int queueSize)</code> +<div class="block">Sets the maximum number of operations that can be asynchronously queued.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setTimeInterval-long-">setTimeInterval</a></span>(long timeInterval)</code> +<div class="block">Sets the number of milliseconds that can elapse before + data written asynchronously is flushed to disk.</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#setWriteBufferSize-int-">setWriteBufferSize</a></span>(int writeBufferSize)</code> +<div class="block">Sets the write buffer size in bytes.</div> +</td> +</tr> +</table> +</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="DEFAULT_DISK_STORE_NAME"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_DISK_STORE_NAME</h4> +<pre>static final java.lang.String DEFAULT_DISK_STORE_NAME</pre> +<div class="block">The name of the default disk store is "DEFAULT". + This name can be used to redefine the default disk store. + Regions that have not had their disk-store-name set will + use this disk store.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_DISK_STORE_NAME">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_AUTO_COMPACT"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_AUTO_COMPACT</h4> +<pre>static final boolean DEFAULT_AUTO_COMPACT</pre> +<div class="block">The default setting for auto compaction. + <p>Current value: <code>true</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_AUTO_COMPACT">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_COMPACTION_THRESHOLD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_COMPACTION_THRESHOLD</h4> +<pre>static final int DEFAULT_COMPACTION_THRESHOLD</pre> +<div class="block">The default compaction threshold. + <p>Current value: <code>50</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_COMPACTION_THRESHOLD">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_ALLOW_FORCE_COMPACTION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_ALLOW_FORCE_COMPACTION</h4> +<pre>static final boolean DEFAULT_ALLOW_FORCE_COMPACTION</pre> +<div class="block">The default value of the allow force compaction attribute. + <p>Current value: <code>false</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_ALLOW_FORCE_COMPACTION">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_MAX_OPLOG_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_MAX_OPLOG_SIZE</h4> +<pre>static final long DEFAULT_MAX_OPLOG_SIZE</pre> +<div class="block">The default maximum oplog file size in megabytes. + <p>Current value: <code>1024</code> which is one gigabyte.</div> +</li> +</ul> +<a name="DEFAULT_TIME_INTERVAL"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_TIME_INTERVAL</h4> +<pre>static final long DEFAULT_TIME_INTERVAL</pre> +<div class="block">The default time interval in milliseconds. + <p>Current value: <code>1000</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_TIME_INTERVAL">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_WRITE_BUFFER_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_WRITE_BUFFER_SIZE</h4> +<pre>static final int DEFAULT_WRITE_BUFFER_SIZE</pre> +<div class="block">The default write buffer size. + <p>Current value: <code>32768</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_WRITE_BUFFER_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_QUEUE_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_QUEUE_SIZE</h4> +<pre>static final int DEFAULT_QUEUE_SIZE</pre> +<div class="block">The default maximum number of operations that can be asynchronously queued. + <p>Current value: <code>0</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_QUEUE_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_DISK_DIRS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_DISK_DIRS</h4> +<pre>static final java.io.File[] DEFAULT_DISK_DIRS</pre> +<div class="block">The default disk directories. + <p>Current value: <code>current directory</code>.</div> +</li> +</ul> +<a name="DEFAULT_DISK_DIR_SIZE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_DISK_DIR_SIZE</h4> +<pre>static final int DEFAULT_DISK_DIR_SIZE</pre> +<div class="block">The default disk directory size in megabytes. + <p>Current value: <code>2,147,483,647</code> which is two petabytes.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_DISK_DIR_SIZE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_DISK_DIR_SIZES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_DISK_DIR_SIZES</h4> +<pre>static final int[] DEFAULT_DISK_DIR_SIZES</pre> +<div class="block">The default disk directory sizes. + <p>Current value: <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_DISK_DIR_SIZE"><code>DEFAULT_DISK_DIR_SIZE</code></a> which is two petabytes each.</div> +</li> +</ul> +<a name="DEFAULT_DISK_USAGE_WARNING_PERCENTAGE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_DISK_USAGE_WARNING_PERCENTAGE</h4> +<pre>static final float DEFAULT_DISK_USAGE_WARNING_PERCENTAGE</pre> +<div class="block">The default disk usage warning percentage. + <p>Current value: <code>90</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_DISK_USAGE_WARNING_PERCENTAGE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="DEFAULT_DISK_USAGE_CRITICAL_PERCENTAGE"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT_DISK_USAGE_CRITICAL_PERCENTAGE</h4> +<pre>static final float DEFAULT_DISK_USAGE_CRITICAL_PERCENTAGE</pre> +<div class="block">The default disk usage critical percentage. + <p>Current value: <code>99</code>.</div> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../constant-values.html#org.apache.geode.cache.DiskStoreFactory.DEFAULT_DISK_USAGE_CRITICAL_PERCENTAGE">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setAutoCompact-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAutoCompact</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setAutoCompact(boolean isAutoCompact)</pre> +<div class="block">Set to <code>true</code> to cause the disk files to be automatically compacted. + Set to <code>false</code> if no compaction is needed or manual compaction will be used.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>isAutoCompact</code> - if true then use auto compaction</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +</dl> +</li> +</ul> +<a name="setCompactionThreshold-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCompactionThreshold</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setCompactionThreshold(int compactionThreshold)</pre> +<div class="block">Sets 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. When the amount of live data in an oplog + becomes less than this percentage then when a compaction is done this + garbage will be cleaned up freeing up disk space. Garbage is created by + entry destroys, entry updates, and region destroys.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>compactionThreshold</code> - percentage of remaining live data in the oplog at which an oplog + is compactable</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +</dl> +</li> +</ul> +<a name="setAllowForceCompaction-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAllowForceCompaction</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setAllowForceCompaction(boolean allowForceCompaction)</pre> +<div class="block">Set to <code>true</code> to allow <a href="../../../../org/apache/geode/cache/DiskStore.html#forceCompaction--"><code>DiskStore.forceCompaction()</code></a> to be called + on regions using this disk store.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>allowForceCompaction</code> - if true then allow force compaction.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +</dl> +</li> +</ul> +<a name="setMaxOplogSize-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxOplogSize</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setMaxOplogSize(long maxOplogSize)</pre> +<div class="block">Sets the maximum size in megabytes a single oplog (operation log) is allowed to be. + When an oplog is created this amount of file space will be immediately reserved.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>maxOplogSize</code> - maximum size in megabytes for one single oplog file.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +</dl> +</li> +</ul> +<a name="setTimeInterval-long-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTimeInterval</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setTimeInterval(long timeInterval)</pre> +<div class="block">Sets the number of milliseconds that can elapse before + data written asynchronously is flushed to disk. + <p>For how to configure a region to be asynchronous see: <a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDiskSynchronous-boolean-"><code>AttributesFactory.setDiskSynchronous(boolean)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>timeInterval</code> - number of milliseconds that can elapse before + async data is flushed to disk.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +</dl> +</li> +</ul> +<a name="setWriteBufferSize-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setWriteBufferSize</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setWriteBufferSize(int writeBufferSize)</pre> +<div class="block">Sets the write buffer size in bytes.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>writeBufferSize</code> - write buffer size in bytes.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +</dl> +</li> +</ul> +<a name="setQueueSize-int-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setQueueSize</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setQueueSize(int queueSize)</pre> +<div class="block">Sets the maximum number of operations that can be asynchronously queued. + Once this many pending async operations have been queued async ops will + begin blocking until some of the queued ops have been flushed to disk. + <p> + For how to configure a region to be asynchronous see: + <a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDiskSynchronous-boolean-"><code>AttributesFactory.setDiskSynchronous(boolean)</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>queueSize</code> - number of operations that can be asynchronously queued. If 0, the + queue will be unlimited.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +</dl> +</li> +</ul> +<a name="setDiskDirs-java.io.File:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDiskDirs</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setDiskDirs(java.io.File[] diskDirs)</pre> +<div class="block">Sets the directories to which this disk store's data is written. If multiple + directories are used, GemFire will attempt to distribute the data evenly + amongst them. + The size of each directory will be set to the default of <a href="../../../../org/apache/geode/cache/DiskStoreFactory.html#DEFAULT_DISK_DIR_SIZE"><code>DEFAULT_DISK_DIR_SIZE</code></a>.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>diskDirs</code> - directories to put the oplog files.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +</dl> +</li> +</ul> +<a name="setDiskDirsAndSizes-java.io.File:A-int:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDiskDirsAndSizes</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setDiskDirsAndSizes(java.io.File[] diskDirs, + int[] diskDirSizes)</pre> +<div class="block">Sets the directories to which this disk store's data is written + and also set the sizes in megabytes of each directory.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>diskDirs</code> - directories to put the oplog files.</dd> +<dd><code>diskDirSizes</code> - sizes of disk directories in megabytes</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if length of the size array + does not match to the length of the dir array</dd> +</dl> +</li> +</ul> +<a name="setDiskUsageWarningPercentage-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDiskUsageWarningPercentage</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setDiskUsageWarningPercentage(float warningPercent)</pre> +<div class="block">Sets the warning threshold for disk usage as a percentage of the total disk + volume.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>warningPercent</code> - warning percent of disk usage</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 8.0</dd> +</dl> +</li> +</ul> +<a name="setDiskUsageCriticalPercentage-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDiskUsageCriticalPercentage</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStoreFactory.html" title="interface in org.apache.geode.cache">DiskStoreFactory</a> setDiskUsageCriticalPercentage(float criticalPercent)</pre> +<div class="block">Sets the critical threshold for disk usage as a percentage of the total disk + volume.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>criticalPercent</code> - critical percent of disk usage</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>a reference to <code>this</code></dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 8.0</dd> +</dl> +</li> +</ul> +<a name="create-java.lang.String-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>create</h4> +<pre><a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache">DiskStore</a> create(java.lang.String name)</pre> +<div class="block">Create a new disk store or find an existing one. In either case the returned disk store's + configuration will be the same as this factory's configuration.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>name</code> - the name of the DiskStore</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the newly created DiskStore.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code>java.lang.IllegalStateException</code> - if a disk store with the given name already exists + and its configuration is not consistent with this factory.</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/DiskStore.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/DiskWriteAttributes.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/DiskStoreFactory.html" target="_top">Frames</a></li> +<li><a href="DiskStoreFactory.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>Constr | </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>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> http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/8888a496/releases/latest/javadoc/org/apache/geode/cache/DiskWriteAttributes.html ---------------------------------------------------------------------- diff --git a/releases/latest/javadoc/org/apache/geode/cache/DiskWriteAttributes.html b/releases/latest/javadoc/org/apache/geode/cache/DiskWriteAttributes.html new file mode 100644 index 0000000..78032c9 --- /dev/null +++ b/releases/latest/javadoc/org/apache/geode/cache/DiskWriteAttributes.html @@ -0,0 +1,386 @@ +<!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 (1.8.0_45) on Sat Oct 15 16:23:28 PDT 2016 --> +<title>DiskWriteAttributes (Apache Geode (incubating) 1.0.0-incubating)</title> +<meta name="date" content="2016-10-15"> +<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="DiskWriteAttributes (Apache Geode (incubating) 1.0.0-incubating)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":38,"i1":38,"i2":38,"i3":38,"i4":38,"i5":38}; +var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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="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/DiskStoreFactory.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/DiskWriteAttributesFactory.html" title="class 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/DiskWriteAttributes.html" target="_top">Frames</a></li> +<li><a href="DiskWriteAttributes.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 DiskWriteAttributes" class="title">Interface DiskWriteAttributes</h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Superinterfaces:</dt> +<dd>java.io.Serializable</dd> +</dl> +<hr> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html" title="interface in org.apache.geode.cache"><code>DiskStore</code></a> instead</span></div> +</div> +<br> +<pre>@Deprecated +public interface <span class="typeNameLabel">DiskWriteAttributes</span> +extends java.io.Serializable</pre> +<div class="block">Immutable parameter object for describing how <a href="../../../../org/apache/geode/cache/Region.Entry.html" title="interface in org.apache.geode.cache">region entries</a> should be written to disk.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>GemFire 3.2</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../../org/apache/geode/cache/DiskWriteAttributesFactory.html" title="class in org.apache.geode.cache"><code>DiskWriteAttributesFactory</code></a>, +<a href="../../../../org/apache/geode/cache/AttributesFactory.html#setDiskWriteAttributes-org.apache.geode.cache.DiskWriteAttributes-"><code>AttributesFactory.setDiskWriteAttributes(org.apache.geode.cache.DiskWriteAttributes)</code></a>, +<a href="../../../../org/apache/geode/cache/RegionAttributes.html#getDiskWriteAttributes--"><code>RegionAttributes.getDiskWriteAttributes()</code></a>, +<a href="../../../../org/apache/geode/cache/Region.html#writeToDisk--"><code>Region.writeToDisk()</code></a></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><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>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object o)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Two <code>DiskWriteAttributes</code> are equal if the both + specify the synchronous writes, or they both specify asynchronous + writes with the same time interval, bytes threshold, maxOplogSize and + compaction values</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html#getBytesThreshold--">getBytesThreshold</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getQueueSize--"><code>DiskStore.getQueueSize()</code></a> + instead.</span></div> +</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/geode/cache/DiskWriteAttributes.html#getMaxOplogSize--">getMaxOplogSize</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getMaxOplogSize--"><code>DiskStore.getMaxOplogSize()</code></a> + instead.</span></div> +</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/geode/cache/DiskWriteAttributes.html#getTimeInterval--">getTimeInterval</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getTimeInterval--"><code>DiskStore.getTimeInterval()</code></a> + instead.</span></div> +</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/DiskWriteAttributes.html#isRollOplogs--">isRollOplogs</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns true if the oplogs is to be rolled to a more condensed format (on disk)</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/DiskWriteAttributes.html#isSynchronous--">isSynchronous</a></span>()</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#isDiskSynchronous--"><code>RegionAttributes.isDiskSynchronous()</code></a> instead.</span></div> +</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="isSynchronous--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isSynchronous</h4> +<pre>@Deprecated +boolean isSynchronous()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/RegionAttributes.html#isDiskSynchronous--"><code>RegionAttributes.isDiskSynchronous()</code></a> instead.</span></div> +<div class="block">Returns true if this <code>DiskWriteAttributes</code> object + configures synchronous writes.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Returns true if writes to disk are synchronous and false otherwise</dd> +</dl> +</li> +</ul> +<a name="isRollOplogs--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isRollOplogs</h4> +<pre>boolean isRollOplogs()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Returns true if the oplogs is to be rolled to a more condensed format (on disk)</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Returns true if the oplogs is to be rolled or false otherwise</dd> +</dl> +</li> +</ul> +<a name="getMaxOplogSize--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxOplogSize</h4> +<pre>@Deprecated +int getMaxOplogSize()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getMaxOplogSize--"><code>DiskStore.getMaxOplogSize()</code></a> + instead.</span></div> +<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 the operations log file can be</dd> +</dl> +</li> +</ul> +<a name="getTimeInterval--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTimeInterval</h4> +<pre>@Deprecated +long getTimeInterval()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getTimeInterval--"><code>DiskStore.getTimeInterval()</code></a> + instead.</span></div> +<div class="block">Returns the number of milliseconds that can elapse before + unwritten data is written to disk. If this + <code>DiskWriteAttributes</code> configures synchronous writing, + then <code>timeInterval</code> has no meaning.</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="getBytesThreshold--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBytesThreshold</h4> +<pre>@Deprecated +long getBytesThreshold()</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">as of 6.5 use <a href="../../../../org/apache/geode/cache/DiskStore.html#getQueueSize--"><code>DiskStore.getQueueSize()</code></a> + instead.</span></div> +<div class="block">Returns the number of unwritten bytes of data that can be + enqueued before being written to disk. If this + <code>DiskWriteAttributes</code> configures synchronous writing, + then <code>bytesThreshold</code> has no meaning.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Returns the number of bytes that can be buffered before being written to disk</dd> +</dl> +</li> +</ul> +<a name="equals-java.lang.Object-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>equals</h4> +<pre>boolean equals(java.lang.Object o)</pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> </div> +<div class="block">Two <code>DiskWriteAttributes</code> are equal if the both + specify the synchronous writes, or they both specify asynchronous + writes with the same time interval, bytes threshold, maxOplogSize and + compaction values</div> +<dl> +<dt><span class="overrideSpecifyLabel">Overrides:</span></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>true if o is equal else false</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/DiskStoreFactory.html" title="interface in org.apache.geode.cache"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../../org/apache/geode/cache/DiskWriteAttributesFactory.html" title="class 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/DiskWriteAttributes.html" target="_top">Frames</a></li> +<li><a href="DiskWriteAttributes.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>
