Google Git
Sign in
apache / hbase-site / 03b765b44d7f220e28d9ea78367df882726f2ec9 / . / devapidocs / org / apache / hadoop / hbase / quotas / TimeBasedLimiter.html
blob: 220c17375725650bdbd0777065ac7c4cd843014f [file] [log] [blame]
<!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 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TimeBasedLimiter (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TimeBasedLimiter (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TimeBasedLimiter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/quotas/ThrottleType.html" title="enum in org.apache.hadoop.hbase.quotas"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/quotas/UserQuotaState.html" title="class in org.apache.hadoop.hbase.quotas"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html" target="_top">Frames</a></li>
<li><a href="TimeBasedLimiter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&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="subNavList">
<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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.hbase.quotas</div>
<h2 title="Class TimeBasedLimiter" class="title">Class TimeBasedLimiter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.hbase.quotas.TimeBasedLimiter</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
@InterfaceStability.Evolving
public class <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.35">TimeBasedLimiter</a>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
implements <a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></pre>
<div class="block">Simple time based limiter that checks the quota Throttle</div>
</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">&nbsp;</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>private static org.apache.hadoop.conf.Configuration</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#conf">conf</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#readCapacityUnitLimiter">readCapacityUnitLimiter</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#readReqsLimiter">readReqsLimiter</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#readSizeLimiter">readSizeLimiter</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#reqCapacityUnitLimiter">reqCapacityUnitLimiter</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#reqSizeLimiter">reqSizeLimiter</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#reqsLimiter">reqsLimiter</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#writeCapacityUnitLimiter">writeCapacityUnitLimiter</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#writeReqsLimiter">writeReqsLimiter</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#writeSizeLimiter">writeSizeLimiter</a></span></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>private </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#TimeBasedLimiter--">TimeBasedLimiter</a></span>()</code>&nbsp;</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">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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/hadoop/hbase/quotas/TimeBasedLimiter.html#checkQuota-long-long-long-long-long-long-">checkQuota</a></span>(long&nbsp;writeReqs,
long&nbsp;estimateWriteSize,
long&nbsp;readReqs,
long&nbsp;estimateReadSize,
long&nbsp;estimateWriteCapacityUnit,
long&nbsp;estimateReadCapacityUnit)</code>
<div class="block">Checks if it is possible to execute the specified operation.</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/hadoop/hbase/quotas/TimeBasedLimiter.html#consumeRead-long-long-">consumeRead</a></span>(long&nbsp;size,
long&nbsp;capacityUnit)</code>
<div class="block">Removes or add back some read amount to the quota.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#consumeWrite-long-long-">consumeWrite</a></span>(long&nbsp;size,
long&nbsp;capacityUnit)</code>
<div class="block">Removes or add back some write amount to the quota.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>(package private) static <a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#fromThrottle-org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Throttle-">fromThrottle</a></span>(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Throttle&nbsp;throttle)</code>&nbsp;</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#getReadAvailable--">getReadAvailable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#getWriteAvailable--">getWriteAvailable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#grabQuota-long-long-long-long-long-long-">grabQuota</a></span>(long&nbsp;writeReqs,
long&nbsp;writeSize,
long&nbsp;readReqs,
long&nbsp;readSize,
long&nbsp;writeCapacityUnit,
long&nbsp;readCapacityUnit)</code>
<div class="block">Removes the specified write and read amount from the quota.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#isBypass--">isBypass</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>private static void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#setFromTimedQuota-org.apache.hadoop.hbase.quotas.RateLimiter-org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota-">setFromTimedQuota</a></span>(<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a>&nbsp;limiter,
org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota&nbsp;timedQuota)</code>&nbsp;</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#toString--">toString</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#update-org.apache.hadoop.hbase.quotas.TimeBasedLimiter-">update</a></span>(<a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html" title="class in org.apache.hadoop.hbase.quotas">TimeBasedLimiter</a>&nbsp;other)</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="conf">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>conf</h4>
<pre>private static final&nbsp;org.apache.hadoop.conf.Configuration <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.36">conf</a></pre>
</li>
</ul>
<a name="reqsLimiter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reqsLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.37">reqsLimiter</a></pre>
</li>
</ul>
<a name="reqSizeLimiter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reqSizeLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.38">reqSizeLimiter</a></pre>
</li>
</ul>
<a name="writeReqsLimiter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeReqsLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.39">writeReqsLimiter</a></pre>
</li>
</ul>
<a name="writeSizeLimiter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeSizeLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.40">writeSizeLimiter</a></pre>
</li>
</ul>
<a name="readReqsLimiter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readReqsLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.41">readReqsLimiter</a></pre>
</li>
</ul>
<a name="readSizeLimiter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>readSizeLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.42">readSizeLimiter</a></pre>
</li>
</ul>
<a name="reqCapacityUnitLimiter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reqCapacityUnitLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.43">reqCapacityUnitLimiter</a></pre>
</li>
</ul>
<a name="writeCapacityUnitLimiter">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>writeCapacityUnitLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.44">writeCapacityUnitLimiter</a></pre>
</li>
</ul>
<a name="readCapacityUnitLimiter">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>readCapacityUnitLimiter</h4>
<pre>private&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.45">readCapacityUnitLimiter</a></pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TimeBasedLimiter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TimeBasedLimiter</h4>
<pre>private&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.47">TimeBasedLimiter</a>()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="fromThrottle-org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Throttle-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>fromThrottle</h4>
<pre>static&nbsp;<a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.73">fromThrottle</a>(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Throttle&nbsp;throttle)</pre>
</li>
</ul>
<a name="update-org.apache.hadoop.hbase.quotas.TimeBasedLimiter-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>update</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.123">update</a>(<a href="../../../../../org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html" title="class in org.apache.hadoop.hbase.quotas">TimeBasedLimiter</a>&nbsp;other)</pre>
</li>
</ul>
<a name="setFromTimedQuota-org.apache.hadoop.hbase.quotas.RateLimiter-org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setFromTimedQuota</h4>
<pre>private static&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.135">setFromTimedQuota</a>(<a href="../../../../../org/apache/hadoop/hbase/quotas/RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a>&nbsp;limiter,
org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota&nbsp;timedQuota)</pre>
</li>
</ul>
<a name="checkQuota-long-long-long-long-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkQuota</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.140">checkQuota</a>(long&nbsp;writeReqs,
long&nbsp;estimateWriteSize,
long&nbsp;readReqs,
long&nbsp;estimateReadSize,
long&nbsp;estimateWriteCapacityUnit,
long&nbsp;estimateReadCapacityUnit)
throws <a href="../../../../../org/apache/hadoop/hbase/quotas/RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#checkQuota-long-long-long-long-long-long-">QuotaLimiter</a></code></span></div>
<div class="block">Checks if it is possible to execute the specified operation.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#checkQuota-long-long-long-long-long-long-">checkQuota</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writeReqs</code> - the write requests that will be checked against the available quota</dd>
<dd><code>estimateWriteSize</code> - the write size that will be checked against the available quota</dd>
<dd><code>readReqs</code> - the read requests that will be checked against the available quota</dd>
<dd><code>estimateReadSize</code> - the read size that will be checked against the available quota</dd>
<dd><code>estimateWriteCapacityUnit</code> - the write capacity unit that will be checked against the
available quota</dd>
<dd><code>estimateReadCapacityUnit</code> - the read capacity unit that will be checked against the
available quota</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></code> - thrown if not enough available resources to perform operation.</dd>
</dl>
</li>
</ul>
<a name="grabQuota-long-long-long-long-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>grabQuota</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.185">grabQuota</a>(long&nbsp;writeReqs,
long&nbsp;writeSize,
long&nbsp;readReqs,
long&nbsp;readSize,
long&nbsp;writeCapacityUnit,
long&nbsp;readCapacityUnit)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#grabQuota-long-long-long-long-long-long-">QuotaLimiter</a></code></span></div>
<div class="block">Removes the specified write and read amount from the quota.
At this point the write and read amount will be an estimate,
that will be later adjusted with a consumeWrite()/consumeRead() call.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#grabQuota-long-long-long-long-long-long-">grabQuota</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>writeReqs</code> - the write requests that will be removed from the current quota</dd>
<dd><code>writeSize</code> - the write size that will be removed from the current quota</dd>
<dd><code>readReqs</code> - the read requests that will be removed from the current quota</dd>
<dd><code>readSize</code> - the read size that will be removed from the current quota</dd>
<dd><code>writeCapacityUnit</code> - the write capacity unit that will be removed from the current quota</dd>
<dd><code>readCapacityUnit</code> - the read capacity unit num that will be removed from the current quota</dd>
</dl>
</li>
</ul>
<a name="consumeWrite-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>consumeWrite</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.211">consumeWrite</a>(long&nbsp;size,
long&nbsp;capacityUnit)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#consumeWrite-long-long-">QuotaLimiter</a></code></span></div>
<div class="block">Removes or add back some write amount to the quota.
(called at the end of an operation in case the estimate quota was off)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#consumeWrite-long-long-">consumeWrite</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd>
</dl>
</li>
</ul>
<a name="consumeRead-long-long-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>consumeRead</h4>
<pre>public&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.219">consumeRead</a>(long&nbsp;size,
long&nbsp;capacityUnit)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from interface:&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#consumeRead-long-long-">QuotaLimiter</a></code></span></div>
<div class="block">Removes or add back some read amount to the quota.
(called at the end of an operation in case the estimate quota was off)</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#consumeRead-long-long-">consumeRead</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd>
</dl>
</li>
</ul>
<a name="isBypass--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isBypass</h4>
<pre>public&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.227">isBypass</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#isBypass--">isBypass</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the limiter is a noop</dd>
</dl>
</li>
</ul>
<a name="getWriteAvailable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteAvailable</h4>
<pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.232">getWriteAvailable</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#getWriteAvailable--">getWriteAvailable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes available to write to avoid exceeding the quota</dd>
</dl>
</li>
</ul>
<a name="getReadAvailable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadAvailable</h4>
<pre>public&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.237">getReadAvailable</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html#getReadAvailable--">getReadAvailable</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/apache/hadoop/hbase/quotas/QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the number of bytes available to read to avoid exceeding the quota</dd>
</dl>
</li>
</ul>
<a name="toString--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line.242">toString</a>()</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TimeBasedLimiter.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/hbase/quotas/ThrottleType.html" title="enum in org.apache.hadoop.hbase.quotas"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/quotas/UserQuotaState.html" title="class in org.apache.hadoop.hbase.quotas"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html" target="_top">Frames</a></li>
<li><a href="TimeBasedLimiter.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&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="subNavList">
<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>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007&#x2013;2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>