| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CompactedHFilesDischarger (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.regionserver, class: CompactedHFilesDischarger"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/CompactedHFilesDischarger.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.regionserver</a></div> |
| <h1 title="Class CompactedHFilesDischarger" class="title">Class CompactedHFilesDischarger</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../ScheduledChore.html" title="class in org.apache.hadoop.hbase">org.apache.hadoop.hbase.ScheduledChore</a> |
| <div class="inheritance">org.apache.hadoop.hbase.regionserver.CompactedHFilesDischarger</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Runnable.html" title="class or interface in java.lang" class="external-link">Runnable</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/CompactedHFilesDischarger.html#line-35">CompactedHFilesDischarger</a></span> |
| <span class="extends-implements">extends <a href="../ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a></span></div> |
| <div class="block">A chore service that periodically cleans up the compacted files when there are no active readers |
| using those compacted files and also helps in clearing the block cache of these compacted file |
| entries.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div> |
| <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#regionServerServices" class="member-name-link">regionServerServices</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#useExecutor" class="member-name-link">useExecutor</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(int,org.apache.hadoop.hbase.Stoppable,org.apache.hadoop.hbase.regionserver.RegionServerServices)" class="member-name-link">CompactedHFilesDischarger</a><wbr>(int period, |
| <a href="../Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, |
| <a href="RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a> regionServerServices)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(int,org.apache.hadoop.hbase.Stoppable,org.apache.hadoop.hbase.regionserver.RegionServerServices,boolean)" class="member-name-link">CompactedHFilesDischarger</a><wbr>(int period, |
| <a href="../Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, |
| <a href="RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a> regionServerServices, |
| boolean useExecutor)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#chore()" class="member-name-link">chore</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">The task to execute on each scheduled execution of the Chore</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setUseExecutor(boolean)" class="member-name-link">setUseExecutor</a><wbr>(boolean useExecutor)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">CompactedHFilesDischarger runs asynchronously by default using the hosting RegionServer's |
| Executor.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.ScheduledChore">Methods inherited from class org.apache.hadoop.hbase.<a href="../ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a></h3> |
| <code><a href="../ScheduledChore.html#cancel()">cancel</a>, <a href="../ScheduledChore.html#cancel(boolean)">cancel</a>, <a href="../ScheduledChore.html#choreForTesting()">choreForTesting</a>, <a href="../ScheduledChore.html#cleanup()">cleanup</a>, <a href="../ScheduledChore.html#getInitialDelay()">getInitialDelay</a>, <a href="../ScheduledChore.html#getName()">getName</a>, <a href="../ScheduledChore.html#getPeriod()">getPeriod</a>, <a href="../ScheduledChore.html#getStopper()">getStopper</a>, <a href="../ScheduledChore.html#getTimeUnit()">getTimeUnit</a>, <a href="../ScheduledChore.html#initialChore()">initialChore</a>, <a href="../ScheduledChore.html#isInitialChoreComplete()">isInitialChoreComplete</a>, <a href="../ScheduledChore.html#isScheduled()">isScheduled</a>, <a href="../ScheduledChore.html#run()">run</a>, <a href="../ScheduledChore.html#shutdown()">shutdown</a>, <a href="../ScheduledChore.html#shutdown(boolean)">shutdown</a>, <a href="../ScheduledChore.html#toString()">toString</a>, <a href="../ScheduledChore.html#triggerNow()">triggerNow</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="LOG"> |
| <h3>LOG</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/CompactedHFilesDischarger.html#line-37">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="regionServerServices"> |
| <h3>regionServerServices</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/CompactedHFilesDischarger.html#line-38">regionServerServices</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="useExecutor"> |
| <h3>useExecutor</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/CompactedHFilesDischarger.html#line-40">useExecutor</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>(int,org.apache.hadoop.hbase.Stoppable,org.apache.hadoop.hbase.regionserver.RegionServerServices)"> |
| <h3>CompactedHFilesDischarger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/CompactedHFilesDischarger.html#line-47">CompactedHFilesDischarger</a></span><wbr><span class="parameters">(int period, |
| <a href="../Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, |
| <a href="RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a> regionServerServices)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>period</code> - the period of time to sleep between each run</dd> |
| <dd><code>stopper</code> - the stopper</dd> |
| <dd><code>regionServerServices</code> - the region server that starts this chore</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(int,org.apache.hadoop.hbase.Stoppable,org.apache.hadoop.hbase.regionserver.RegionServerServices,boolean)"> |
| <h3>CompactedHFilesDischarger</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/CompactedHFilesDischarger.html#line-61">CompactedHFilesDischarger</a></span><wbr><span class="parameters">(int period, |
| <a href="../Stoppable.html" title="interface in org.apache.hadoop.hbase">Stoppable</a> stopper, |
| <a href="RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a> regionServerServices, |
| boolean useExecutor)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>period</code> - the period of time to sleep between each run</dd> |
| <dd><code>stopper</code> - the stopper</dd> |
| <dd><code>regionServerServices</code> - the region server that starts this chore</dd> |
| <dd><code>useExecutor</code> - true if to use the region server's executor service, false |
| otherwise</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="setUseExecutor(boolean)"> |
| <h3>setUseExecutor</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/CompactedHFilesDischarger.html#line-74">setUseExecutor</a></span><wbr><span class="parameters">(boolean useExecutor)</span></div> |
| <div class="block">CompactedHFilesDischarger runs asynchronously by default using the hosting RegionServer's |
| Executor. In tests it can be useful to force a synchronous cleanup. Use this method to set |
| no-executor before you call run.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>The old setting for <code>useExecutor</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="chore()"> |
| <h3>chore</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/regionserver/CompactedHFilesDischarger.html#line-82">chore</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../ScheduledChore.html#chore()">ScheduledChore</a></code></span></div> |
| <div class="block">The task to execute on each scheduled execution of the Chore</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ScheduledChore.html#chore()">chore</a></code> in class <code><a href="../ScheduledChore.html" title="class in org.apache.hadoop.hbase">ScheduledChore</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
