devapidocs/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html - hbase-site - Git at Google

 <!DOCTYPE HTML>
 <html lang="en">
 <head>
 <!-- Generated by javadoc (17) -->
 <title>RegionServerRpcQuotaManager (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: RegionServerRpcQuotaManager">
 <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/RegionServerRpcQuotaManager.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 RegionServerRpcQuotaManager" class="title">Class RegionServerRpcQuotaManager</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.RegionServerRpcQuotaManager</div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code><a href="RpcQuotaManager.html" title="interface in org.apache.hadoop.hbase.quotas">RpcQuotaManager</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/RegionServerRpcQuotaManager.html#line-44">RegionServerRpcQuotaManager</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="RpcQuotaManager.html" title="interface in org.apache.hadoop.hbase.quotas">RpcQuotaManager</a></span></div>
 <div class="block">Region Server Quota Manager. It is responsible to provide access to the quota information of each
  user/table. The direct user of this class is the RegionServer that will get and check the
  user/table quota for each operation (put, get, scan). For system tables and user/table with a
  quota specified, the quota check will be a noop.</div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="caption"><span>Fields</span></div>
 <div class="summary-table three-column-summary">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Field</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><code>private static final org.slf4j.Logger</code></div>
 <div class="col-second even-row-color"><code><a href="#LOG" class="member-name-link">LOG</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private <a href="QuotaCache.html" title="class in org.apache.hadoop.hbase.quotas">QuotaCache</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#quotaCache" class="member-name-link">quotaCache</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private boolean</code></div>
 <div class="col-second even-row-color"><code><a href="#rpcThrottleEnabled" class="member-name-link">rpcThrottleEnabled</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 <div class="col-first odd-row-color"><code>private <a href="RpcThrottleStorage.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottleStorage</a></code></div>
 <div class="col-second odd-row-color"><code><a href="#rpcThrottleStorage" class="member-name-link">rpcThrottleStorage</a></code></div>
 <div class="col-last odd-row-color">&nbsp;</div>
 <div class="col-first even-row-color"><code>private final <a href="../regionserver/RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a></code></div>
 <div class="col-second even-row-color"><code><a href="#rsServices" class="member-name-link">rsServices</a></code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.regionserver.RegionServerServices)" class="member-name-link">RegionServerRpcQuotaManager</a><wbr>(<a href="../regionserver/RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a>&nbsp;rsServices)</code></div>
 <div class="col-last even-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><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,int,int)" class="member-name-link">checkBatchQuota</a><wbr>(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a>&nbsp;region,
  int&nbsp;numWrites,
  int&nbsp;numReads)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Check the quota for the current (rpc-context) user.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,java.util.List,boolean)" class="member-name-link">checkBatchQuota</a><wbr>(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a>&nbsp;region,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Action&gt;&nbsp;actions,
  boolean&nbsp;hasCondition)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Check the quota for the current (rpc-context) user.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.quotas.OperationQuota.OperationType)" class="member-name-link">checkBatchQuota</a><wbr>(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a>&nbsp;region,
  <a href="OperationQuota.OperationType.html" title="enum class in org.apache.hadoop.hbase.quotas">OperationQuota.OperationType</a>&nbsp;type)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Check the quota for the current (rpc-context) user.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkScanQuota(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)" class="member-name-link">checkScanQuota</a><wbr>(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a>&nbsp;region,
  org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest&nbsp;scanRequest,
  long&nbsp;maxScannerResultSize,
  long&nbsp;maxBlockBytesScanned,
  long&nbsp;prevBlockBytesScannedDifference)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Check the quota for the current (rpc-context) user.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuota(org.apache.hadoop.security.UserGroupInformation,org.apache.hadoop.hbase.TableName,int)" class="member-name-link">getQuota</a><wbr>(org.apache.hadoop.security.UserGroupInformation&nbsp;ugi,
  <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;table,
  int&nbsp;blockSizeBytes)</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 quota for an operation.</div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <a href="QuotaCache.html" title="class in org.apache.hadoop.hbase.quotas">QuotaCache</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getQuotaCache()" class="member-name-link">getQuotaCache</a>()</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>private boolean</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isQuotaEnabled()" class="member-name-link">isQuotaEnabled</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>protected boolean</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isRpcThrottleEnabled()" class="member-name-link">isRpcThrottleEnabled</a>()</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>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#start(org.apache.hadoop.hbase.ipc.RpcScheduler)" class="member-name-link">start</a><wbr>(<a href="../ipc/RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a>&nbsp;rpcScheduler)</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>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stop()" class="member-name-link">stop</a>()</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>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#switchRpcThrottle(boolean)" class="member-name-link">switchRpcThrottle</a><wbr>(boolean&nbsp;enable)</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-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#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ============ FIELD DETAIL =========== -->
 <li>
 <section class="field-details" id="field-detail">
 <h2>Field Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="LOG">
 <h3>LOG</h3>
 <div class="member-signature"><span class="modifiers">private static final</span>&nbsp;<span class="return-type">org.slf4j.Logger</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-47">LOG</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="rsServices">
 <h3>rsServices</h3>
 <div class="member-signature"><span class="modifiers">private final</span>&nbsp;<span class="return-type"><a href="../regionserver/RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-49">rsServices</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="quotaCache">
 <h3>quotaCache</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="QuotaCache.html" title="class in org.apache.hadoop.hbase.quotas">QuotaCache</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-51">quotaCache</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="rpcThrottleEnabled">
 <h3>rpcThrottleEnabled</h3>
 <div class="member-signature"><span class="modifiers">private volatile</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-52">rpcThrottleEnabled</a></span></div>
 </section>
 </li>
 <li>
 <section class="detail" id="rpcThrottleStorage">
 <h3>rpcThrottleStorage</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type"><a href="RpcThrottleStorage.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottleStorage</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-54">rpcThrottleStorage</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;(org.apache.hadoop.hbase.regionserver.RegionServerServices)">
 <h3>RegionServerRpcQuotaManager</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-56">RegionServerRpcQuotaManager</a></span><wbr><span class="parameters">(<a href="../regionserver/RegionServerServices.html" title="interface in org.apache.hadoop.hbase.regionserver">RegionServerServices</a>&nbsp;rsServices)</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="start(org.apache.hadoop.hbase.ipc.RpcScheduler)">
 <h3>start</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/RegionServerRpcQuotaManager.html#line-62">start</a></span><wbr><span class="parameters">(<a href="../ipc/RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a>&nbsp;rpcScheduler)</span>
            throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="stop()">
 <h3>stop</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/RegionServerRpcQuotaManager.html#line-77">stop</a></span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="isRpcThrottleEnabled()">
 <h3>isRpcThrottleEnabled</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-83">isRpcThrottleEnabled</a></span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="isQuotaEnabled()">
 <h3>isQuotaEnabled</h3>
 <div class="member-signature"><span class="modifiers">private</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-87">isQuotaEnabled</a></span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="switchRpcThrottle(boolean)">
 <h3>switchRpcThrottle</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/RegionServerRpcQuotaManager.html#line-91">switchRpcThrottle</a></span><wbr><span class="parameters">(boolean&nbsp;enable)</span>
                        throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getQuotaCache()">
 <h3>getQuotaCache</h3>
 <div class="member-signature"><span class="return-type"><a href="QuotaCache.html" title="class in org.apache.hadoop.hbase.quotas">QuotaCache</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-107">getQuotaCache</a></span>()</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getQuota(org.apache.hadoop.security.UserGroupInformation,org.apache.hadoop.hbase.TableName,int)">
 <h3>getQuota</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-117">getQuota</a></span><wbr><span class="parameters">(org.apache.hadoop.security.UserGroupInformation&nbsp;ugi,
  <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;table,
  int&nbsp;blockSizeBytes)</span></div>
 <div class="block">Returns the quota for an operation.</div>
 <dl class="notes">
 <dt>Parameters:</dt>
 <dd><code>ugi</code> - the user that is executing the operation</dd>
 <dd><code>table</code> - the table where the operation will be executed</dd>
 <dt>Returns:</dt>
 <dd>the OperationQuota</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="checkScanQuota(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)">
 <h3>checkScanQuota</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-157">checkScanQuota</a></span><wbr><span class="parameters">(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a>&nbsp;region,
  org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest&nbsp;scanRequest,
  long&nbsp;maxScannerResultSize,
  long&nbsp;maxBlockBytesScanned,
  long&nbsp;prevBlockBytesScannedDifference)</span>
                               throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>,
 <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:&nbsp;<code><a href="RpcQuotaManager.html#checkScanQuota(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)">RpcQuotaManager</a></code></span></div>
 <div class="block">Check the quota for the current (rpc-context) user. Returns the OperationQuota used to get the
  available quota and to report the data/usage of the operation. This method is specific to scans
  because estimating a scan's workload is more complicated than estimating the workload of a
  get/put.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="RpcQuotaManager.html#checkScanQuota(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ScanRequest,long,long,long)">checkScanQuota</a></code>&nbsp;in interface&nbsp;<code><a href="RpcQuotaManager.html" title="interface in org.apache.hadoop.hbase.quotas">RpcQuotaManager</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>region</code> - the region where the operation will be performed</dd>
 <dd><code>scanRequest</code> - the scan to be estimated against the quota</dd>
 <dd><code>maxScannerResultSize</code> - the maximum bytes to be returned by the scanner</dd>
 <dd><code>maxBlockBytesScanned</code> - the maximum bytes scanned in a single RPC call by the
                                         scanner</dd>
 <dd><code>prevBlockBytesScannedDifference</code> - the difference between BBS of the previous two next
                                         calls</dd>
 <dt>Returns:</dt>
 <dd>the OperationQuota</dd>
 <dt>Throws:</dt>
 <dd><code><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></code> - if the operation cannot be executed due to quota exceeded.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.quotas.OperationQuota.OperationType)">
 <h3>checkBatchQuota</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-184">checkBatchQuota</a></span><wbr><span class="parameters">(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a>&nbsp;region,
  <a href="OperationQuota.OperationType.html" title="enum class in org.apache.hadoop.hbase.quotas">OperationQuota.OperationType</a>&nbsp;type)</span>
                                throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>,
 <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:&nbsp;<code><a href="RpcQuotaManager.html#checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.quotas.OperationQuota.OperationType)">RpcQuotaManager</a></code></span></div>
 <div class="block">Check the quota for the current (rpc-context) user. Returns the OperationQuota used to get the
  available quota and to report the data/usage of the operation. This method does not support
  scans because estimating a scan's workload is more complicated than estimating the workload of
  a get/put.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="RpcQuotaManager.html#checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,org.apache.hadoop.hbase.quotas.OperationQuota.OperationType)">checkBatchQuota</a></code>&nbsp;in interface&nbsp;<code><a href="RpcQuotaManager.html" title="interface in org.apache.hadoop.hbase.quotas">RpcQuotaManager</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>region</code> - the region where the operation will be performed</dd>
 <dd><code>type</code> - the operation type</dd>
 <dt>Returns:</dt>
 <dd>the OperationQuota</dd>
 <dt>Throws:</dt>
 <dd><code><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></code> - if the operation cannot be executed due to quota exceeded.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,java.util.List,boolean)">
 <h3>checkBatchQuota</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-198">checkBatchQuota</a></span><wbr><span class="parameters">(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a>&nbsp;region,
  <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.Action&gt;&nbsp;actions,
  boolean&nbsp;hasCondition)</span>
                                throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>,
 <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:&nbsp;<code><a href="RpcQuotaManager.html#checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,java.util.List,boolean)">RpcQuotaManager</a></code></span></div>
 <div class="block">Check the quota for the current (rpc-context) user. Returns the OperationQuota used to get the
  available quota and to report the data/usage of the operation. This method does not support
  scans because estimating a scan's workload is more complicated than estimating the workload of
  a get/put.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="RpcQuotaManager.html#checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,java.util.List,boolean)">checkBatchQuota</a></code>&nbsp;in interface&nbsp;<code><a href="RpcQuotaManager.html" title="interface in org.apache.hadoop.hbase.quotas">RpcQuotaManager</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>region</code> - the region where the operation will be performed</dd>
 <dd><code>actions</code> - the "multi" actions to perform</dd>
 <dd><code>hasCondition</code> - whether the RegionAction has a condition</dd>
 <dt>Returns:</dt>
 <dd>the OperationQuota</dd>
 <dt>Throws:</dt>
 <dd><code><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></code> - if the operation cannot be executed due to quota exceeded.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,int,int)">
 <h3>checkBatchQuota</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="OperationQuota.html" title="interface in org.apache.hadoop.hbase.quotas">OperationQuota</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/quotas/RegionServerRpcQuotaManager.html#line-228">checkBatchQuota</a></span><wbr><span class="parameters">(<a href="../regionserver/Region.html" title="interface in org.apache.hadoop.hbase.regionserver">Region</a>&nbsp;region,
  int&nbsp;numWrites,
  int&nbsp;numReads)</span>
                                throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>,
 <a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></span></div>
 <div class="block">Check the quota for the current (rpc-context) user. Returns the OperationQuota used to get the
  available quota and to report the data/usage of the operation.</div>
 <dl class="notes">
 <dt>Specified by:</dt>
 <dd><code><a href="RpcQuotaManager.html#checkBatchQuota(org.apache.hadoop.hbase.regionserver.Region,int,int)">checkBatchQuota</a></code>&nbsp;in interface&nbsp;<code><a href="RpcQuotaManager.html" title="interface in org.apache.hadoop.hbase.quotas">RpcQuotaManager</a></code></dd>
 <dt>Parameters:</dt>
 <dd><code>region</code> - the region where the operation will be performed</dd>
 <dd><code>numWrites</code> - number of writes to perform</dd>
 <dd><code>numReads</code> - number of short-reads to perform</dd>
 <dt>Returns:</dt>
 <dd>the OperationQuota</dd>
 <dt>Throws:</dt>
 <dd><code><a href="RpcThrottlingException.html" title="class in org.apache.hadoop.hbase.quotas">RpcThrottlingException</a></code> - if the operation cannot be executed due to quota exceeded.</dd>
 <dd><code>RpcThrottlingException</code> - if the operation cannot be executed due to quota exceeded.</dd>
 <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</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>