blob: 5121a1d6b73e485037ea144f25e475ad7053dc60 [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>RpcScheduler (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="RpcScheduler (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6,"i14":6,"i15":6,"i16":6,"i17":6,"i18":6,"i19":6,"i20":6,"i21":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/RpcScheduler.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/ipc/RpcResponse.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.Context.html" title="class in org.apache.hadoop.hbase.ipc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/ipc/RpcScheduler.html" target="_top">Frames</a></li>
<li><a href="RpcScheduler.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><a href="#nested.class.summary">Nested</a>&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.ipc</div>
<h2 title="Class RpcScheduler" class="title">Class RpcScheduler</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.ipc.RpcScheduler</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/hadoop/hbase/ipc/FifoRpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">FifoRpcScheduler</a>, <a href="../../../../../org/apache/hadoop/hbase/ipc/SimpleRpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">SimpleRpcScheduler</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.LimitedPrivate(value={"Coprocesssor","Phoenix"})
@InterfaceStability.Evolving
public abstract class <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.32">RpcScheduler</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></pre>
<div class="block">An interface for RPC request scheduling algorithm.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.Context.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler.Context</a></span></code>
<div class="block">Exposes runtime information of a <code>RpcServer</code> that a <code>RpcScheduler</code> may need.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== 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>static <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/ipc/RpcScheduler.html#IPC_SERVER_MAX_CALLQUEUE_LENGTH">IPC_SERVER_MAX_CALLQUEUE_LENGTH</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <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/ipc/RpcScheduler.html#IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH">IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <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/ipc/RpcScheduler.html#IPC_SERVER_REPLICATION_MAX_CALLQUEUE_LENGTH">IPC_SERVER_REPLICATION_MAX_CALLQUEUE_LENGTH</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="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#RpcScheduler--">RpcScheduler</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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#dispatch-org.apache.hadoop.hbase.ipc.CallRunner-">dispatch</a></span>(<a href="../../../../../org/apache/hadoop/hbase/ipc/CallRunner.html" title="class in org.apache.hadoop.hbase.ipc">CallRunner</a>&nbsp;task)</code>
<div class="block">Dispatches an RPC request asynchronously.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getActiveGeneralRpcHandlerCount--">getActiveGeneralRpcHandlerCount</a></span>()</code>
<div class="block">Retrieves the number of active general handler.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getActiveMetaPriorityRpcHandlerCount--">getActiveMetaPriorityRpcHandlerCount</a></span>()</code>
<div class="block">Retrieves the number of active meta priority handler.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getActivePriorityRpcHandlerCount--">getActivePriorityRpcHandlerCount</a></span>()</code>
<div class="block">Retrieves the number of active priority handler.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getActiveReadRpcHandlerCount--">getActiveReadRpcHandlerCount</a></span>()</code>
<div class="block">Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getActiveReplicationRpcHandlerCount--">getActiveReplicationRpcHandlerCount</a></span>()</code>
<div class="block">Retrieves the number of active replication handler.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getActiveRpcHandlerCount--">getActiveRpcHandlerCount</a></span>()</code>
<div class="block">Retrieves the total number of active handler.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getActiveScanRpcHandlerCount--">getActiveScanRpcHandlerCount</a></span>()</code>
<div class="block">Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getActiveWriteRpcHandlerCount--">getActiveWriteRpcHandlerCount</a></span>()</code>
<div class="block">Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../../../org/apache/hadoop/hbase/ipc/CallQueueInfo.html" title="class in org.apache.hadoop.hbase.ipc">CallQueueInfo</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getCallQueueInfo--">getCallQueueInfo</a></span>()</code>
<div class="block">Get call queue information</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getGeneralQueueLength--">getGeneralQueueLength</a></span>()</code>
<div class="block">Retrieves length of the general queue for metrics.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getMetaPriorityQueueLength--">getMetaPriorityQueueLength</a></span>()</code>
<div class="block">Retrieves length of the meta priority queue for metrics.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>abstract long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getNumGeneralCallsDropped--">getNumGeneralCallsDropped</a></span>()</code>
<div class="block">If CoDel-based RPC executors are used, retrieves the number of Calls that were dropped
from general queue because RPC executor is under high load; returns 0 otherwise.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>abstract long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getNumLifoModeSwitches--">getNumLifoModeSwitches</a></span>()</code>
<div class="block">If CoDel-based RPC executors are used, retrieves the number of Calls that were
picked from the tail of the queue (indicating adaptive LIFO mode, when
in the period of overloade we serve last requests first); returns 0 otherwise.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getPriorityQueueLength--">getPriorityQueueLength</a></span>()</code>
<div class="block">Retrieves length of the priority queue for metrics.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getReadQueueLength--">getReadQueueLength</a></span>()</code>
<div class="block">Retrieves length of the read queue for metrics when use RWQueueRpcExecutor.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getReplicationQueueLength--">getReplicationQueueLength</a></span>()</code>
<div class="block">Retrieves length of the replication queue for metrics.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getScanQueueLength--">getScanQueueLength</a></span>()</code>
<div class="block">Retrieves length of the scan queue for metrics when use RWQueueRpcExecutor.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code>abstract int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#getWriteQueueLength--">getWriteQueueLength</a></span>()</code>
<div class="block">Retrieves length of the write queue for metrics when use RWQueueRpcExecutor.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#init-org.apache.hadoop.hbase.ipc.RpcScheduler.Context-">init</a></span>(<a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.Context.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler.Context</a>&nbsp;context)</code>
<div class="block">Does some quick initialization.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#start--">start</a></span>()</code>
<div class="block">Prepares for request serving.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#stop--">stop</a></span>()</code>
<div class="block">Stops serving new requests.</div>
</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#toString--" title="class or interface in java.lang">toString</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="IPC_SERVER_MAX_CALLQUEUE_LENGTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IPC_SERVER_MAX_CALLQUEUE_LENGTH</h4>
<pre>public static final&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> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.34">IPC_SERVER_MAX_CALLQUEUE_LENGTH</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcScheduler.IPC_SERVER_MAX_CALLQUEUE_LENGTH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH</h4>
<pre>public static final&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> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.36">IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcScheduler.IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="IPC_SERVER_REPLICATION_MAX_CALLQUEUE_LENGTH">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>IPC_SERVER_REPLICATION_MAX_CALLQUEUE_LENGTH</h4>
<pre>public static final&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> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.38">IPC_SERVER_REPLICATION_MAX_CALLQUEUE_LENGTH</a></pre>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcScheduler.IPC_SERVER_REPLICATION_MAX_CALLQUEUE_LENGTH">Constant Field Values</a></dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="RpcScheduler--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>RpcScheduler</h4>
<pre>public&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.32">RpcScheduler</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="init-org.apache.hadoop.hbase.ipc.RpcScheduler.Context-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>init</h4>
<pre>public abstract&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.52">init</a>(<a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.Context.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler.Context</a>&nbsp;context)</pre>
<div class="block">Does some quick initialization. Heavy tasks (e.g. starting threads) should be
done in <a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.html#start--"><code>start()</code></a>. This method is called before <code>start</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>context</code> - provides methods to retrieve runtime information from</dd>
</dl>
</li>
</ul>
<a name="start--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>start</h4>
<pre>public abstract&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.57">start</a>()</pre>
<div class="block">Prepares for request serving. An implementation may start some handler threads here.</div>
</li>
</ul>
<a name="stop--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>stop</h4>
<pre>public abstract&nbsp;void&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.60">stop</a>()</pre>
<div class="block">Stops serving new requests.</div>
</li>
</ul>
<a name="dispatch-org.apache.hadoop.hbase.ipc.CallRunner-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>dispatch</h4>
<pre>public abstract&nbsp;boolean&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.68">dispatch</a>(<a href="../../../../../org/apache/hadoop/hbase/ipc/CallRunner.html" title="class in org.apache.hadoop.hbase.ipc">CallRunner</a>&nbsp;task)
throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>,
<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></pre>
<div class="block">Dispatches an RPC request asynchronously. An implementation is free to choose to process the
request immediately or delay it for later processing.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>task</code> - the request to be dispatched</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true" title="class or interface in java.lang">InterruptedException</a></code></dd>
</dl>
</li>
</ul>
<a name="getCallQueueInfo--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCallQueueInfo</h4>
<pre>public abstract&nbsp;<a href="../../../../../org/apache/hadoop/hbase/ipc/CallQueueInfo.html" title="class in org.apache.hadoop.hbase.ipc">CallQueueInfo</a>&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.71">getCallQueueInfo</a>()</pre>
<div class="block">Get call queue information</div>
</li>
</ul>
<a name="getGeneralQueueLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGeneralQueueLength</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.74">getGeneralQueueLength</a>()</pre>
<div class="block">Retrieves length of the general queue for metrics.</div>
</li>
</ul>
<a name="getPriorityQueueLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPriorityQueueLength</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.77">getPriorityQueueLength</a>()</pre>
<div class="block">Retrieves length of the priority queue for metrics.</div>
</li>
</ul>
<a name="getMetaPriorityQueueLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMetaPriorityQueueLength</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.80">getMetaPriorityQueueLength</a>()</pre>
<div class="block">Retrieves length of the meta priority queue for metrics.</div>
</li>
</ul>
<a name="getReplicationQueueLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReplicationQueueLength</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.83">getReplicationQueueLength</a>()</pre>
<div class="block">Retrieves length of the replication queue for metrics.</div>
</li>
</ul>
<a name="getActiveRpcHandlerCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveRpcHandlerCount</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.86">getActiveRpcHandlerCount</a>()</pre>
<div class="block">Retrieves the total number of active handler.</div>
</li>
</ul>
<a name="getActiveGeneralRpcHandlerCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveGeneralRpcHandlerCount</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.89">getActiveGeneralRpcHandlerCount</a>()</pre>
<div class="block">Retrieves the number of active general handler.</div>
</li>
</ul>
<a name="getActivePriorityRpcHandlerCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActivePriorityRpcHandlerCount</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.92">getActivePriorityRpcHandlerCount</a>()</pre>
<div class="block">Retrieves the number of active priority handler.</div>
</li>
</ul>
<a name="getActiveMetaPriorityRpcHandlerCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveMetaPriorityRpcHandlerCount</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.95">getActiveMetaPriorityRpcHandlerCount</a>()</pre>
<div class="block">Retrieves the number of active meta priority handler.</div>
</li>
</ul>
<a name="getActiveReplicationRpcHandlerCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveReplicationRpcHandlerCount</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.98">getActiveReplicationRpcHandlerCount</a>()</pre>
<div class="block">Retrieves the number of active replication handler.</div>
</li>
</ul>
<a name="getNumGeneralCallsDropped--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumGeneralCallsDropped</h4>
<pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.104">getNumGeneralCallsDropped</a>()</pre>
<div class="block">If CoDel-based RPC executors are used, retrieves the number of Calls that were dropped
from general queue because RPC executor is under high load; returns 0 otherwise.</div>
</li>
</ul>
<a name="getNumLifoModeSwitches--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumLifoModeSwitches</h4>
<pre>public abstract&nbsp;long&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.111">getNumLifoModeSwitches</a>()</pre>
<div class="block">If CoDel-based RPC executors are used, retrieves the number of Calls that were
picked from the tail of the queue (indicating adaptive LIFO mode, when
in the period of overloade we serve last requests first); returns 0 otherwise.</div>
</li>
</ul>
<a name="getWriteQueueLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteQueueLength</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.114">getWriteQueueLength</a>()</pre>
<div class="block">Retrieves length of the write queue for metrics when use RWQueueRpcExecutor.</div>
</li>
</ul>
<a name="getReadQueueLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadQueueLength</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.117">getReadQueueLength</a>()</pre>
<div class="block">Retrieves length of the read queue for metrics when use RWQueueRpcExecutor.</div>
</li>
</ul>
<a name="getScanQueueLength--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getScanQueueLength</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.120">getScanQueueLength</a>()</pre>
<div class="block">Retrieves length of the scan queue for metrics when use RWQueueRpcExecutor.</div>
</li>
</ul>
<a name="getActiveWriteRpcHandlerCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveWriteRpcHandlerCount</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.123">getActiveWriteRpcHandlerCount</a>()</pre>
<div class="block">Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.</div>
</li>
</ul>
<a name="getActiveReadRpcHandlerCount--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getActiveReadRpcHandlerCount</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.126">getActiveReadRpcHandlerCount</a>()</pre>
<div class="block">Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.</div>
</li>
</ul>
<a name="getActiveScanRpcHandlerCount--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getActiveScanRpcHandlerCount</h4>
<pre>public abstract&nbsp;int&nbsp;<a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcScheduler.html#line.129">getActiveScanRpcHandlerCount</a>()</pre>
<div class="block">Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.</div>
</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/RpcScheduler.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/ipc/RpcResponse.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/hbase/ipc/RpcScheduler.Context.html" title="class in org.apache.hadoop.hbase.ipc"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/hbase/ipc/RpcScheduler.html" target="_top">Frames</a></li>
<li><a href="RpcScheduler.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><a href="#nested.class.summary">Nested</a>&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>