| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>TimeBasedLimiter (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: TimeBasedLimiter"> |
| <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/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#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.quotas</a></div> |
| <h1 title="Class TimeBasedLimiter" class="title">Class TimeBasedLimiter</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">org.apache.hadoop.hbase.quotas.TimeBasedLimiter</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| <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/TimeBasedLimiter.html#line-32">TimeBasedLimiter</a></span> |
| <span class="extends-implements">extends <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> |
| implements <a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></span></div> |
| <div class="block">Simple time based limiter that checks the quota Throttle</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.apache.hadoop.conf.Configuration</code></div> |
| <div class="col-second even-row-color"><code><a href="#conf" class="member-name-link">conf</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#readCapacityUnitLimiter" class="member-name-link">readCapacityUnitLimiter</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#readReqsLimiter" class="member-name-link">readReqsLimiter</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#readSizeLimiter" class="member-name-link">readSizeLimiter</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#reqCapacityUnitLimiter" class="member-name-link">reqCapacityUnitLimiter</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#reqSizeLimiter" class="member-name-link">reqSizeLimiter</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#reqsLimiter" class="member-name-link">reqsLimiter</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#writeCapacityUnitLimiter" class="member-name-link">writeCapacityUnitLimiter</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#writeReqsLimiter" class="member-name-link">writeReqsLimiter</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#writeSizeLimiter" class="member-name-link">writeSizeLimiter</a></code></div> |
| <div class="col-last odd-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 three-column-summary"> |
| <div class="table-header col-first">Modifier</div> |
| <div class="table-header col-second">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>private </code></div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">TimeBasedLimiter</a>()</code></div> |
| <div class="col-last even-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-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static 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="#checkQuota(long,long,long,long,long,long)" class="member-name-link">checkQuota</a><wbr>(long writeReqs, |
| long estimateWriteSize, |
| long readReqs, |
| long estimateReadSize, |
| long estimateWriteCapacityUnit, |
| long estimateReadCapacityUnit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Checks if it is possible to execute the specified operation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#consumeRead(long,long)" class="member-name-link">consumeRead</a><wbr>(long size, |
| long capacityUnit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes or add back some read amount to the quota.</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="#consumeWrite(long,long)" class="member-name-link">consumeWrite</a><wbr>(long size, |
| long capacityUnit)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes or add back some write amount to the quota.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>(package private) static <a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#fromThrottle(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Throttle)" class="member-name-link">fromThrottle</a><wbr>(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Throttle throttle)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </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="#getReadAvailable()" class="member-name-link">getReadAvailable</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of bytes available to read to avoid exceeding the quota</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="#getReadLimit()" class="member-name-link">getReadLimit</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum number of bytes ever available to read</div> |
| </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="#getReadNumLimit()" class="member-name-link">getReadNumLimit</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum number of reads to allow per TimeUnit</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="#getRequestNumLimit()" class="member-name-link">getRequestNumLimit</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum number of requests to allow per TimeUnit</div> |
| </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="#getWriteAvailable()" class="member-name-link">getWriteAvailable</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the number of bytes available to write to avoid exceeding the quota</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="#getWriteLimit()" class="member-name-link">getWriteLimit</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum number of bytes ever available to write</div> |
| </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="#getWriteNumLimit()" class="member-name-link">getWriteNumLimit</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns the maximum number of writes to allow per TimeUnit</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#grabQuota(long,long,long,long,long,long)" class="member-name-link">grabQuota</a><wbr>(long writeReqs, |
| long writeSize, |
| long readReqs, |
| long readSize, |
| long writeCapacityUnit, |
| long readCapacityUnit)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Removes the specified write and read amount from the quota.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isBypass()" class="member-name-link">isBypass</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns true if the limiter is a noop</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#setFromTimedQuota(org.apache.hadoop.hbase.quotas.RateLimiter,org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota)" class="member-name-link">setFromTimedQuota</a><wbr>(<a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> limiter, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota timedQuota)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#update(org.apache.hadoop.hbase.quotas.TimeBasedLimiter)" class="member-name-link">update</a><wbr>(<a href="TimeBasedLimiter.html" title="class in org.apache.hadoop.hbase.quotas">TimeBasedLimiter</a> other)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </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="conf"> |
| <h3>conf</h3> |
| <div class="member-signature"><span class="modifiers">private static final</span> <span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-35">conf</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reqsLimiter"> |
| <h3>reqsLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-36">reqsLimiter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reqSizeLimiter"> |
| <h3>reqSizeLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-37">reqSizeLimiter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeReqsLimiter"> |
| <h3>writeReqsLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-38">writeReqsLimiter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeSizeLimiter"> |
| <h3>writeSizeLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-39">writeSizeLimiter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readReqsLimiter"> |
| <h3>readReqsLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-40">readReqsLimiter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readSizeLimiter"> |
| <h3>readSizeLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-41">readSizeLimiter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reqCapacityUnitLimiter"> |
| <h3>reqCapacityUnitLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-42">reqCapacityUnitLimiter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="writeCapacityUnitLimiter"> |
| <h3>writeCapacityUnitLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-43">writeCapacityUnitLimiter</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="readCapacityUnitLimiter"> |
| <h3>readCapacityUnitLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-44">readCapacityUnitLimiter</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>()"> |
| <h3>TimeBasedLimiter</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-46">TimeBasedLimiter</a></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="fromThrottle(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Throttle)"> |
| <h3>fromThrottle</h3> |
| <div class="member-signature"><span class="modifiers">static</span> <span class="return-type"><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-76">fromThrottle</a></span><wbr><span class="parameters">(org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.Throttle throttle)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="update(org.apache.hadoop.hbase.quotas.TimeBasedLimiter)"> |
| <h3>update</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/quotas/TimeBasedLimiter.html#line-126">update</a></span><wbr><span class="parameters">(<a href="TimeBasedLimiter.html" title="class in org.apache.hadoop.hbase.quotas">TimeBasedLimiter</a> other)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFromTimedQuota(org.apache.hadoop.hbase.quotas.RateLimiter,org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota)"> |
| <h3>setFromTimedQuota</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-138">setFromTimedQuota</a></span><wbr><span class="parameters">(<a href="RateLimiter.html" title="class in org.apache.hadoop.hbase.quotas">RateLimiter</a> limiter, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.QuotaProtos.TimedQuota timedQuota)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="checkQuota(long,long,long,long,long,long)"> |
| <h3>checkQuota</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/quotas/TimeBasedLimiter.html#line-142">checkQuota</a></span><wbr><span class="parameters">(long writeReqs, |
| long estimateWriteSize, |
| long readReqs, |
| long estimateReadSize, |
| long estimateWriteCapacityUnit, |
| long estimateReadCapacityUnit)</span> |
| throws <span class="exceptions"><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#checkQuota(long,long,long,long,long,long)">checkQuota</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| <dt>Parameters:</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>Throws:</dt> |
| <dd><code><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></code> - thrown if not enough available resources to perform operation.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="grabQuota(long,long,long,long,long,long)"> |
| <h3>grabQuota</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/quotas/TimeBasedLimiter.html#line-191">grabQuota</a></span><wbr><span class="parameters">(long writeReqs, |
| long writeSize, |
| long readReqs, |
| long readSize, |
| long writeCapacityUnit, |
| long readCapacityUnit)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#grabQuota(long,long,long,long,long,long)">grabQuota</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| <dt>Parameters:</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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="consumeWrite(long,long)"> |
| <h3>consumeWrite</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/quotas/TimeBasedLimiter.html#line-217">consumeWrite</a></span><wbr><span class="parameters">(long size, |
| long capacityUnit)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#consumeWrite(long,long)">consumeWrite</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="consumeRead(long,long)"> |
| <h3>consumeRead</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/quotas/TimeBasedLimiter.html#line-225">consumeRead</a></span><wbr><span class="parameters">(long size, |
| long capacityUnit)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="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 class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#consumeRead(long,long)">consumeRead</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isBypass()"> |
| <h3>isBypass</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/quotas/TimeBasedLimiter.html#line-233">isBypass</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaLimiter.html#isBypass()">QuotaLimiter</a></code></span></div> |
| <div class="block">Returns true if the limiter is a noop</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#isBypass()">isBypass</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWriteAvailable()"> |
| <h3>getWriteAvailable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-238">getWriteAvailable</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaLimiter.html#getWriteAvailable()">QuotaLimiter</a></code></span></div> |
| <div class="block">Returns the number of bytes available to write to avoid exceeding the quota</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#getWriteAvailable()">getWriteAvailable</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestNumLimit()"> |
| <h3>getRequestNumLimit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-243">getRequestNumLimit</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaLimiter.html#getRequestNumLimit()">QuotaLimiter</a></code></span></div> |
| <div class="block">Returns the maximum number of requests to allow per TimeUnit</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#getRequestNumLimit()">getRequestNumLimit</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReadNumLimit()"> |
| <h3>getReadNumLimit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-254">getReadNumLimit</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaLimiter.html#getReadNumLimit()">QuotaLimiter</a></code></span></div> |
| <div class="block">Returns the maximum number of reads to allow per TimeUnit</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#getReadNumLimit()">getReadNumLimit</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWriteNumLimit()"> |
| <h3>getWriteNumLimit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-259">getWriteNumLimit</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaLimiter.html#getWriteNumLimit()">QuotaLimiter</a></code></span></div> |
| <div class="block">Returns the maximum number of writes to allow per TimeUnit</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#getWriteNumLimit()">getWriteNumLimit</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReadAvailable()"> |
| <h3>getReadAvailable</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-264">getReadAvailable</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaLimiter.html#getReadAvailable()">QuotaLimiter</a></code></span></div> |
| <div class="block">Returns the number of bytes available to read to avoid exceeding the quota</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#getReadAvailable()">getReadAvailable</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getReadLimit()"> |
| <h3>getReadLimit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-269">getReadLimit</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaLimiter.html#getReadLimit()">QuotaLimiter</a></code></span></div> |
| <div class="block">Returns the maximum number of bytes ever available to read</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#getReadLimit()">getReadLimit</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWriteLimit()"> |
| <h3>getWriteLimit</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-274">getWriteLimit</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="QuotaLimiter.html#getWriteLimit()">QuotaLimiter</a></code></span></div> |
| <div class="block">Returns the maximum number of bytes ever available to write</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="QuotaLimiter.html#getWriteLimit()">getWriteLimit</a></code> in interface <code><a href="QuotaLimiter.html" title="interface in org.apache.hadoop.hbase.quotas">QuotaLimiter</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="toString()"> |
| <h3>toString</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/TimeBasedLimiter.html#line-279">toString</a></span>()</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a></code> in class <code><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></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> |
