blob: 29717be78a3b12464392de0ae9c98f0713616c4f [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>FixedIntervalRateLimiter (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.quotas, class: FixedIntervalRateLimiter">
<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/FixedIntervalRateLimiter.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li><a href="#field-detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.quotas</a></div>
<h1 title="Class FixedIntervalRateLimiter" class="title">Class FixedIntervalRateLimiter</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="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">org.apache.hadoop.hbase.quotas.RateLimiter</a>
<div class="inheritance">org.apache.hadoop.hbase.quotas.FixedIntervalRateLimiter</div>
</div>
</div>
<section class="class-description" id="class-description">
<hr>
<div class="type-signature"><span class="annotations">@Private
@Evolving
</span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-29">FixedIntervalRateLimiter</a></span>
<span class="extends-implements">extends <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span></div>
<div class="block">With this limiter resources will be refilled only after a fixed interval of time.</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 long</code></div>
<div class="col-second even-row-color"><code><a href="#nextRefillTime" class="member-name-link">nextRefillTime</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div>
<div class="col-second odd-row-color"><code><a href="#RATE_LIMITER_REFILL_INTERVAL_MS" class="member-name-link">RATE_LIMITER_REFILL_INTERVAL_MS</a></code></div>
<div class="col-last odd-row-color">
<div class="block">The FixedIntervalRateLimiter can be harsh from a latency/backoff perspective, which makes it
difficult to fully and consistently utilize a quota allowance.</div>
</div>
<div class="col-first even-row-color"><code>private final long</code></div>
<div class="col-second even-row-color"><code><a href="#refillInterval" class="member-name-link">refillInterval</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
<div class="inherited-list">
<h3 id="fields-inherited-from-class-org.apache.hadoop.hbase.quotas.RateLimiter">Fields inherited from class&nbsp;org.apache.hadoop.hbase.quotas.<a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></h3>
<code><a href="RateLimiter.html#DEFAULT_TIME_UNIT">DEFAULT_TIME_UNIT</a>, <a href="RateLimiter.html#QUOTA_RATE_LIMITER_CONF_KEY">QUOTA_RATE_LIMITER_CONF_KEY</a></code></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()" class="member-name-link">FixedIntervalRateLimiter</a>()</code></div>
<div class="col-last even-row-color">&nbsp;</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(long)" class="member-name-link">FixedIntervalRateLimiter</a><wbr>(long&nbsp;refillInterval)</code></div>
<div class="col-last odd-row-color">&nbsp;</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>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getNextRefillTime()" class="member-name-link">getNextRefillTime</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRefillIntervalAdjustedLimit(long)" class="member-name-link">getRefillIntervalAdjustedLimit</a><wbr>(long&nbsp;limit)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWaitInterval(long,long,long)" class="member-name-link">getWaitInterval</a><wbr>(long&nbsp;limit,
long&nbsp;available,
long&nbsp;amount)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Time in milliseconds to wait for before requesting to consume 'amount' resource.</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#refill(long)" class="member-name-link">refill</a><wbr>(long&nbsp;limit)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Refill the available units w.r.t the elapsed time.</div>
</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="#setNextRefillTime(long)" class="member-name-link">setNextRefillTime</a><wbr>(long&nbsp;nextRefillTime)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.quotas.RateLimiter">Methods inherited from class&nbsp;org.apache.hadoop.hbase.quotas.<a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></h3>
<code><a href="RateLimiter.html#consume()">consume</a>, <a href="RateLimiter.html#consume(long)">consume</a>, <a href="RateLimiter.html#getAvailable()">getAvailable</a>, <a href="RateLimiter.html#getLimit()">getLimit</a>, <a href="RateLimiter.html#getTimeUnitInMillis()">getTimeUnitInMillis</a>, <a href="RateLimiter.html#getWaitIntervalMs()">getWaitIntervalMs</a>, <a href="RateLimiter.html#getWaitIntervalMs(long)">getWaitIntervalMs</a>, <a href="RateLimiter.html#isAvailable(long)">isAvailable</a>, <a href="RateLimiter.html#isBypass()">isBypass</a>, <a href="RateLimiter.html#set(long,java.util.concurrent.TimeUnit)">set</a>, <a href="RateLimiter.html#toString()">toString</a>, <a href="RateLimiter.html#update(org.apache.hadoop.hbase.quotas.RateLimiter)">update</a>, <a href="RateLimiter.html#waitInterval()">waitInterval</a>, <a href="RateLimiter.html#waitInterval(long)">waitInterval</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;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="RATE_LIMITER_REFILL_INTERVAL_MS">
<h3>RATE_LIMITER_REFILL_INTERVAL_MS</h3>
<div class="member-signature"><span class="modifiers">public static final</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-43">RATE_LIMITER_REFILL_INTERVAL_MS</a></span></div>
<div class="block">The FixedIntervalRateLimiter can be harsh from a latency/backoff perspective, which makes it
difficult to fully and consistently utilize a quota allowance. By configuring the
<a href="#RATE_LIMITER_REFILL_INTERVAL_MS"><code>RATE_LIMITER_REFILL_INTERVAL_MS</code></a> to a lower value you will encourage the rate limiter
to throw smaller wait intervals for requests which may be fulfilled in timeframes shorter than
the quota's full interval. For example, if you're saturating a 100MB/sec read IO quota with a
ton of tiny gets, then configuring this to a value like 100ms will ensure that your retry
backoffs approach ~100ms, rather than 1sec. Be careful not to configure this too low, or you
may produce a dangerous amount of retry volume.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="see-list">
<li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.quotas.FixedIntervalRateLimiter.RATE_LIMITER_REFILL_INTERVAL_MS">Constant Field Values</a></li>
</ul>
</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="nextRefillTime">
<h3>nextRefillTime</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-46">nextRefillTime</a></span></div>
</section>
</li>
<li>
<section class="detail" id="refillInterval">
<h3>refillInterval</h3>
<div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-47">refillInterval</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="&lt;init&gt;()">
<h3>FixedIntervalRateLimiter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-49">FixedIntervalRateLimiter</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(long)">
<h3>FixedIntervalRateLimiter</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-53">FixedIntervalRateLimiter</a></span><wbr><span class="parameters">(long&nbsp;refillInterval)</span></div>
</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="refill(long)">
<h3>refill</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-61">refill</a></span><wbr><span class="parameters">(long&nbsp;limit)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="RateLimiter.html#refill(long)">RateLimiter</a></code></span></div>
<div class="block">Refill the available units w.r.t the elapsed time.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RateLimiter.html#refill(long)">refill</a></code>&nbsp;in class&nbsp;<code><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></dd>
<dt>Parameters:</dt>
<dd><code>limit</code> - Maximum available resource units that can be refilled to.</dd>
<dt>Returns:</dt>
<dd>how many resource units may be refilled ?</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getWaitInterval(long,long,long)">
<h3>getWaitInterval</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-78">getWaitInterval</a></span><wbr><span class="parameters">(long&nbsp;limit,
long&nbsp;available,
long&nbsp;amount)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="RateLimiter.html#getWaitInterval(long,long,long)">RateLimiter</a></code></span></div>
<div class="block">Time in milliseconds to wait for before requesting to consume 'amount' resource.</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RateLimiter.html#getWaitInterval(long,long,long)">getWaitInterval</a></code>&nbsp;in class&nbsp;<code><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></dd>
<dt>Parameters:</dt>
<dd><code>limit</code> - Maximum available resource units that can be refilled to.</dd>
<dd><code>available</code> - Currently available resource units</dd>
<dd><code>amount</code> - Resources for which time interval to calculate for</dd>
<dt>Returns:</dt>
<dd>estimate of the ms required to wait before being able to provide 'amount' resources.</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getRefillIntervalAdjustedLimit(long)">
<h3>getRefillIntervalAdjustedLimit</h3>
<div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-107">getRefillIntervalAdjustedLimit</a></span><wbr><span class="parameters">(long&nbsp;limit)</span></div>
</section>
</li>
<li>
<section class="detail" id="setNextRefillTime(long)">
<h3>setNextRefillTime</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-112">setNextRefillTime</a></span><wbr><span class="parameters">(long&nbsp;nextRefillTime)</span></div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RateLimiter.html#setNextRefillTime(long)">setNextRefillTime</a></code>&nbsp;in class&nbsp;<code><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getNextRefillTime()">
<h3>getNextRefillTime</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">long</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/FixedIntervalRateLimiter.html#line-117">getNextRefillTime</a></span>()</div>
<dl class="notes">
<dt>Specified by:</dt>
<dd><code><a href="RateLimiter.html#getNextRefillTime()">getNextRefillTime</a></code>&nbsp;in class&nbsp;<code><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</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 &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>