| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RpcServer (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.ipc, class: RpcServer"> |
| <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/RpcServer.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><a href="#nested-class-summary">Nested</a> | </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.ipc</a></div> |
| <h1 title="Class RpcServer" class="title">Class RpcServer</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.ipc.RpcServer</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../conf/ConfigurationObserver.html" title="interface in org.apache.hadoop.hbase.conf">ConfigurationObserver</a></code>, <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><code><a href="NettyRpcServer.html" title="class in org.apache.hadoop.hbase.ipc">NettyRpcServer</a></code>, <code><a href="SimpleRpcServer.html" title="class in org.apache.hadoop.hbase.ipc">SimpleRpcServer</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public abstract class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-86">RpcServer</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="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a>, <a href="../conf/ConfigurationObserver.html" title="interface in org.apache.hadoop.hbase.conf">ConfigurationObserver</a></span></div> |
| <div class="block">An RPC server that hosts protobuf described Services.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</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">Class</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="RpcServer.BlockingServiceAndInterface.html" class="type-name-link" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Datastructure for passing a <code>BlockingService</code> and its associated class of protobuf |
| service interface.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected static interface </code></div> |
| <div class="col-second odd-row-color"><code><a href="RpcServer.CallCleanup.html" class="type-name-link" title="interface in org.apache.hadoop.hbase.ipc">RpcServer.CallCleanup</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== 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>protected boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#allowFallbackToSimpleAuth" class="member-name-link">allowFallbackToSimpleAuth</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final org.slf4j.Logger</code></div> |
| <div class="col-second odd-row-color"><code><a href="#AUDITLOG" class="member-name-link">AUDITLOG</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#AUTH_FAILED_FOR" class="member-name-link">AUTH_FAILED_FOR</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#AUTH_SUCCESSFUL_FOR" class="member-name-link">AUTH_SUCCESSFUL_FOR</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected org.apache.hadoop.security.authorize.ServiceAuthorizationManager</code></div> |
| <div class="col-second even-row-color"><code><a href="#authManager" class="member-name-link">authManager</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#authorize" class="member-name-link">authorize</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="../security/token/AuthenticationTokenSecretManager.html" title="class in org.apache.hadoop.hbase.security.token">AuthenticationTokenSecretManager</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#authTokenSecretMgr" class="member-name-link">authTokenSecretMgr</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="../io/ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#bbAllocator" class="member-name-link">bbAllocator</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#bindAddress" class="member-name-link">bindAddress</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="../CallQueueTooBigException.html" title="class in org.apache.hadoop.hbase">CallQueueTooBigException</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CALL_QUEUE_TOO_BIG_EXCEPTION" class="member-name-link">CALL_QUEUE_TOO_BIG_EXCEPTION</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/LongAdder.html" title="class or interface in java.util.concurrent.atomic" class="external-link">LongAdder</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#callQueueSizeInBytes" class="member-name-link">callQueueSizeInBytes</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">This is a running count of the size in bytes of all outstanding calls whether currently |
| executing or queued waiting to be run.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="CellBlockBuilder.html" title="class in org.apache.hadoop.hbase.ipc">CellBlockBuilder</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#cellBlockBuilder" class="member-name-link">cellBlockBuilder</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected 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>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ThreadLocal.html" title="class or interface in java.lang" class="external-link">ThreadLocal</a><<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#CurCall" class="member-name-link">CurCall</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">This is set to Call object before Handler invokes an RPC and ybdie after the call returns.</div> |
| </div> |
| <div class="col-first even-row-color"><code>static final byte</code></div> |
| <div class="col-second even-row-color"><code><a href="#CURRENT_VERSION" class="member-name-link">CURRENT_VERSION</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER" class="member-name-link">DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">How many calls/handler are allowed in the queue.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_MAX_CALLQUEUE_SIZE" class="member-name-link">DEFAULT_MAX_CALLQUEUE_SIZE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_MAX_REQUEST_SIZE" class="member-name-link">DEFAULT_MAX_REQUEST_SIZE</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Default value for above params</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT" class="member-name-link">DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_TRACE_LOG_MAX_LENGTH" class="member-name-link">DEFAULT_TRACE_LOG_MAX_LENGTH</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_WARN_RESPONSE_SIZE" class="member-name-link">DEFAULT_WARN_RESPONSE_SIZE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#DEFAULT_WARN_RESPONSE_TIME" class="member-name-link">DEFAULT_WARN_RESPONSE_TIME</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="HBaseRPCErrorHandler.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRPCErrorHandler</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#errorHandler" class="member-name-link">errorHandler</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#FALLBACK_TO_INSECURE_CLIENT_AUTH" class="member-name-link">FALLBACK_TO_INSECURE_CLIENT_AUTH</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Whether we allow a fallback to SIMPLE auth for insecure clients when security is enabled.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected static final org.apache.hbase.thirdparty.com.google.gson.Gson</code></div> |
| <div class="col-second even-row-color"><code><a href="#GSON" class="member-name-link">GSON</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#isOnlineLogProviderEnabled" class="member-name-link">isOnlineLogProviderEnabled</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#isSecurityEnabled" class="member-name-link">isSecurityEnabled</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#KEY_WORD_TRUNCATED" class="member-name-link">KEY_WORD_TRUNCATED</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>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"> </div> |
| <div class="col-first odd-row-color"><code>static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#MAX_REQUEST_SIZE" class="member-name-link">MAX_REQUEST_SIZE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final long</code></div> |
| <div class="col-second even-row-color"><code><a href="#maxQueueSizeInBytes" class="member-name-link">maxQueueSizeInBytes</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Maximum size in bytes of the currently queued and running Calls.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#maxRequestSize" class="member-name-link">maxRequestSize</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected <a href="MetricsHBaseServer.html" title="class in org.apache.hadoop.hbase.ipc">MetricsHBaseServer</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#metrics" class="member-name-link">metrics</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#MIN_CLIENT_REQUEST_TIMEOUT" class="member-name-link">MIN_CLIENT_REQUEST_TIMEOUT</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Minimum allowable timeout (in milliseconds) in rpc request's header.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#minClientRequestTimeout" class="member-name-link">minClientRequestTimeout</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ThreadLocal.html" title="class or interface in java.lang" class="external-link">ThreadLocal</a><<a href="../monitoring/MonitoredRPCHandler.html" title="interface in org.apache.hadoop.hbase.monitoring">MonitoredRPCHandler</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#MONITORED_RPC" class="member-name-link">MONITORED_RPC</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Keeps MonitoredRPCHandler per handler thread.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#MULTI_GETS" class="member-name-link">MULTI_GETS</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#MULTI_MUTATIONS" class="member-name-link">MULTI_MUTATIONS</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#MULTI_SERVICE_CALLS" class="member-name-link">MULTI_SERVICE_CALLS</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="../namequeues/NamedQueueRecorder.html" title="class in org.apache.hadoop.hbase.namequeues">NamedQueueRecorder</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#namedQueueRecorder" class="member-name-link">namedQueueRecorder</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Use to add online slowlog responses</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#NIO_BUFFER_LIMIT" class="member-name-link">NIO_BUFFER_LIMIT</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">When the read or write buffer size is larger than this limit, i/o will be done in chunks of |
| this size.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private <a href="../regionserver/RSRpcServices.html" title="class in org.apache.hadoop.hbase.regionserver">RSRpcServices</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#rsRpcServices" class="member-name-link">rsRpcServices</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Used to get details for scan with a scanner_id<br/> |
| TODO try to figure out a better way and remove reference from regionserver package later.</div> |
| </div> |
| <div class="col-first even-row-color"><code>(package private) boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#running" class="member-name-link">running</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">This flag is used to indicate to sub threads when they should go down.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#saslProps" class="member-name-link">saslProps</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <a href="RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#scheduler" class="member-name-link">scheduler</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected org.apache.hadoop.security.token.SecretManager<org.apache.hadoop.security.token.TokenIdentifier></code></div> |
| <div class="col-second odd-row-color"><code><a href="#secretManager" class="member-name-link">secretManager</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <a href="../Server.html" title="interface in org.apache.hadoop.hbase">Server</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#server" class="member-name-link">server</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#serverPrincipal" class="member-name-link">serverPrincipal</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected final <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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>></code></div> |
| <div class="col-second even-row-color"><code><a href="#services" class="member-name-link">services</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>(package private) boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#started" class="member-name-link">started</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">This flag is set to true after all threads are up and 'running' and the server is then opened |
| for business by the call to <a href="RpcServerInterface.html#start()"><code>RpcServerInterface.start()</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color"><code>protected final boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#tcpKeepAlive" class="member-name-link">tcpKeepAlive</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#tcpNoDelay" class="member-name-link">tcpNoDelay</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#TRACE_LOG_MAX_LENGTH" class="member-name-link">TRACE_LOG_MAX_LENGTH</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected final <a href="../security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#userProvider" class="member-name-link">userProvider</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#WARN_RESPONSE_SIZE" class="member-name-link">WARN_RESPONSE_SIZE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#WARN_RESPONSE_TIME" class="member-name-link">WARN_RESPONSE_TIME</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#WARN_SCAN_RESPONSE_SIZE" class="member-name-link">WARN_SCAN_RESPONSE_SIZE</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected static final <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#WARN_SCAN_RESPONSE_TIME" class="member-name-link">WARN_SCAN_RESPONSE_TIME</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected int</code></div> |
| <div class="col-second even-row-color"><code><a href="#warnResponseSize" class="member-name-link">warnResponseSize</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#warnResponseTime" class="member-name-link">warnResponseTime</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>protected int</code></div> |
| <div class="col-second even-row-color"><code><a href="#warnScanResponseSize" class="member-name-link">warnScanResponseSize</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>protected int</code></div> |
| <div class="col-second odd-row-color"><code><a href="#warnScanResponseTime" class="member-name-link">warnScanResponseTime</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 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.Server,java.lang.String,java.util.List,java.net.InetSocketAddress,org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.ipc.RpcScheduler,boolean)" class="member-name-link">RpcServer</a><wbr>(<a href="../Server.html" title="interface in org.apache.hadoop.hbase">Server</a> server, |
| <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> name, |
| <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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>> services, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> bindAddress, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a> scheduler, |
| boolean reservoirEnabled)</code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Constructs a server listening on the named port and address.</div> |
| </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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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="#addCallSize(long)" class="member-name-link">addCallSize</a><wbr>(long diff)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Add/subtract from the current size of all outstanding calls.</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="#authorize(org.apache.hadoop.security.UserGroupInformation,org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader,java.net.InetAddress)" class="member-name-link">authorize</a><wbr>(org.apache.hadoop.security.UserGroupInformation user, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader connection, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> addr)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Authorize the incoming client connection.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><org.apache.hbase.thirdparty.com.google.protobuf.Message,<wbr><a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#call(org.apache.hadoop.hbase.ipc.RpcCall,org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler)" class="member-name-link">call</a><wbr>(<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a> call, |
| <a href="../monitoring/MonitoredRPCHandler.html" title="interface in org.apache.hadoop.hbase.monitoring">MonitoredRPCHandler</a> status)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is a server side method, which is invoked over RPC.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#channelIO(java.nio.channels.ReadableByteChannel,java.nio.channels.WritableByteChannel,java.nio.ByteBuffer)" class="member-name-link">channelIO</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels" class="external-link">ReadableByteChannel</a> readCh, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/WritableByteChannel.html" title="class or interface in java.nio.channels" class="external-link">WritableByteChannel</a> writeCh, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buf)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Helper for <a href="#channelRead(java.nio.channels.ReadableByteChannel,java.nio.ByteBuffer)"><code>channelRead(java.nio.channels.ReadableByteChannel, java.nio.ByteBuffer)</code></a>.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#channelRead(java.nio.channels.ReadableByteChannel,java.nio.ByteBuffer)" class="member-name-link">channelRead</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels" class="external-link">ReadableByteChannel</a> channel, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This is a wrapper around |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/ReadableByteChannel.html#read(java.nio.ByteBuffer)" title="class or interface in java.nio.channels" class="external-link"><code>ReadableByteChannel.read(java.nio.ByteBuffer)</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../security/token/AuthenticationTokenSecretManager.html" title="class in org.apache.hadoop.hbase.security.token">AuthenticationTokenSecretManager</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#createSecretManager()" class="member-name-link">createSecretManager</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 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="../io/ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getByteBuffAllocator()" class="member-name-link">getByteBuffAllocator</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Allocator to allocate/free the ByteBuffers, those ByteBuffers can be on-heap or off-heap.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) org.apache.hadoop.conf.Configuration</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConf()" class="member-name-link">getConf</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCurrentCall()" class="member-name-link">getCurrentCall</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Needed for features such as delayed calls.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="ServerCall.html" title="class in org.apache.hadoop.hbase.ipc">ServerCall</a><?>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getCurrentServerCallWithCellScanner()" class="member-name-link">getCurrentServerCallWithCellScanner</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Just return the current rpc call if it is a <a href="ServerCall.html" title="class in org.apache.hadoop.hbase.ipc"><code>ServerCall</code></a> and also has <a href="../CellScanner.html" title="interface in org.apache.hadoop.hbase"><code>CellScanner</code></a> |
| attached.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="HBaseRPCErrorHandler.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRPCErrorHandler</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getErrorHandler()" class="member-name-link">getErrorHandler</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-tab1 method-summary-table-tab4"><code>private static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getIsOnlineLogProviderEnabled(org.apache.hadoop.conf.Configuration)" class="member-name-link">getIsOnlineLogProviderEnabled</a><wbr>(org.apache.hadoop.conf.Configuration conf)</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="MetricsHBaseServer.html" title="class in org.apache.hadoop.hbase.ipc">MetricsHBaseServer</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMetrics()" class="member-name-link">getMetrics</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 metrics instance for reporting RPC call statistics</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>abstract int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getNumOpenConnections()" class="member-name-link">getNumOpenConnections</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">The number of open RPC conections</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRemoteAddress()" class="member-name-link">getRemoteAddress</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the address of the remote client associated with the current RPC request or not present |
| if no address is set.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRemoteIp()" class="member-name-link">getRemoteIp</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the remote side ip address when invoked inside an RPC Returns null incase of an error.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequestUser()" class="member-name-link">getRequestUser</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the user credentials associated with the current RPC request or not present if no |
| credentials were provided.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getRequestUserName()" class="member-name-link">getRequestUserName</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Returns the username for any user associated with the current RPC request or not present if no |
| user is set.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getScheduler()" class="member-name-link">getScheduler</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>org.apache.hadoop.security.token.SecretManager<? extends org.apache.hadoop.security.token.TokenIdentifier></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSecretManager()" class="member-name-link">getSecretManager</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static org.apache.hbase.thirdparty.com.google.protobuf.BlockingService</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getService(java.util.List,java.lang.String)" class="member-name-link">getService</a><wbr>(<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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>> services, |
| <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> serviceName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static <a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getServiceAndInterface(java.util.List,java.lang.String)" class="member-name-link">getServiceAndInterface</a><wbr>(<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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>> services, |
| <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> serviceName)</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-tab1 method-summary-table-tab4"><code>protected static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getServiceInterface(java.util.List,java.lang.String)" class="member-name-link">getServiceInterface</a><wbr>(<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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>> services, |
| <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> serviceName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getServices()" class="member-name-link">getServices</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static <a href="../monitoring/MonitoredRPCHandler.html" title="interface in org.apache.hadoop.hbase.monitoring">MonitoredRPCHandler</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getStatus()" class="member-name-link">getStatus</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getWarnResponseSize(org.apache.hadoop.conf.Configuration)" class="member-name-link">getWarnResponseSize</a><wbr>(org.apache.hadoop.conf.Configuration conf)</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-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getWarnResponseTime(org.apache.hadoop.conf.Configuration)" class="member-name-link">getWarnResponseTime</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getWarnScanResponseSize(org.apache.hadoop.conf.Configuration)" class="member-name-link">getWarnScanResponseSize</a><wbr>(org.apache.hadoop.conf.Configuration conf)</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-tab1 method-summary-table-tab4"><code>private static int</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#getWarnScanResponseTime(org.apache.hadoop.conf.Configuration)" class="member-name-link">getWarnScanResponseTime</a><wbr>(org.apache.hadoop.conf.Configuration conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#initReconfigurable(org.apache.hadoop.conf.Configuration)" class="member-name-link">initReconfigurable</a><wbr>(org.apache.hadoop.conf.Configuration confToLoad)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isInRpcCallContext()" class="member-name-link">isInRpcCallContext</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isStarted()" class="member-name-link">isStarted</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#isTooLarge(org.apache.hadoop.hbase.ipc.RpcCall,long,long)" class="member-name-link">isTooLarge</a><wbr>(<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a> call, |
| long responseSize, |
| long responseBlockSize)</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>private boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isTooSlow(org.apache.hadoop.hbase.ipc.RpcCall,int)" class="member-name-link">isTooSlow</a><wbr>(<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a> call, |
| int processingTime)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#logResponse(org.apache.hbase.thirdparty.com.google.protobuf.Message,java.lang.String,java.lang.String,boolean,boolean,java.lang.String,long,int,int,long,long,long,java.lang.String)" class="member-name-link">logResponse</a><wbr>(org.apache.hbase.thirdparty.com.google.protobuf.Message param, |
| <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> methodName, |
| <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> call, |
| boolean tooLarge, |
| boolean tooSlow, |
| <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> clientAddress, |
| long startTime, |
| int processingTime, |
| int qTime, |
| long responseSize, |
| long blockBytesScanned, |
| long fsReadTime, |
| <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> userName)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Logs an RPC response to the LOG file, producing valid JSON objects for client Operations.</div> |
| </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="#needAuthorization()" class="member-name-link">needAuthorization</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </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="#onConfigurationChange(org.apache.hadoop.conf.Configuration)" class="member-name-link">onConfigurationChange</a><wbr>(org.apache.hadoop.conf.Configuration newConf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This method would be called by the <a href="../conf/ConfigurationManager.html" title="class in org.apache.hadoop.hbase.conf"><code>ConfigurationManager</code></a> object when the |
| <code>Configuration</code> object is reloaded from disk.</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="#refreshAuthManager(org.apache.hadoop.conf.Configuration,org.apache.hadoop.security.authorize.PolicyProvider)" class="member-name-link">refreshAuthManager</a><wbr>(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.security.authorize.PolicyProvider pp)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Refresh authentication manager policy.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>private void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#refreshSlowLogConfiguration(org.apache.hadoop.conf.Configuration)" class="member-name-link">refreshSlowLogConfiguration</a><wbr>(org.apache.hadoop.conf.Configuration newConf)</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-tab1 method-summary-table-tab4"><code>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="#setCurrentCall(org.apache.hadoop.hbase.ipc.RpcCall)" class="member-name-link">setCurrentCall</a><wbr>(<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a> rpcCall)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Used by <a href="../procedure2/store/region/RegionProcedureStore.html" title="class in org.apache.hadoop.hbase.procedure2.store.region"><code>RegionProcedureStore</code></a>.</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="#setErrorHandler(org.apache.hadoop.hbase.ipc.HBaseRPCErrorHandler)" class="member-name-link">setErrorHandler</a><wbr>(<a href="HBaseRPCErrorHandler.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRPCErrorHandler</a> handler)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the handler for calling out of RPC for error conditions.</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="#setNamedQueueRecorder(org.apache.hadoop.hbase.namequeues.NamedQueueRecorder)" class="member-name-link">setNamedQueueRecorder</a><wbr>(<a href="../namequeues/NamedQueueRecorder.html" title="class in org.apache.hadoop.hbase.namequeues">NamedQueueRecorder</a> namedQueueRecorder)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set Online SlowLog Provider</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="#setRsRpcServices(org.apache.hadoop.hbase.regionserver.RSRpcServices)" class="member-name-link">setRsRpcServices</a><wbr>(<a href="../regionserver/RSRpcServices.html" title="class in org.apache.hadoop.hbase.regionserver">RSRpcServices</a> rsRpcServices)</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="#setSecretManager(org.apache.hadoop.security.token.SecretManager)" class="member-name-link">setSecretManager</a><wbr>(org.apache.hadoop.security.token.SecretManager<? extends org.apache.hadoop.security.token.TokenIdentifier> secretManager)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>(package private) <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="#truncateTraceLog(java.lang.String)" class="member-name-link">truncateTraceLog</a><wbr>(<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> strParam)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Truncate to number of chars decided by conf hbase.ipc.trace.log.max.length if TRACE is on else |
| to 150 chars Refer to Jira HBASE-20826 and HBASE-20942</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#unsetCurrentCall()" class="member-name-link">unsetCurrentCall</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Used by <a href="../procedure2/store/region/RegionProcedureStore.html" title="class in org.apache.hadoop.hbase.procedure2.store.region"><code>RegionProcedureStore</code></a>.</div> |
| </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#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> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.ipc.RpcServerInterface">Methods inherited from interface org.apache.hadoop.hbase.ipc.<a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></h3> |
| <code><a href="RpcServerInterface.html#getListenerAddress()">getListenerAddress</a>, <a href="RpcServerInterface.html#join()">join</a>, <a href="RpcServerInterface.html#setSocketSendBufSize(int)">setSocketSendBufSize</a>, <a href="RpcServerInterface.html#start()">start</a>, <a href="RpcServerInterface.html#stop()">stop</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">public static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-89">LOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CALL_QUEUE_TOO_BIG_EXCEPTION"> |
| <h3>CALL_QUEUE_TOO_BIG_EXCEPTION</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="../CallQueueTooBigException.html" title="class in org.apache.hadoop.hbase">CallQueueTooBigException</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-90">CALL_QUEUE_TOO_BIG_EXCEPTION</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MULTI_GETS"> |
| <h3>MULTI_GETS</h3> |
| <div class="member-signature"><span class="modifiers">private static final</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/ipc/RpcServer.html#line-93">MULTI_GETS</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.MULTI_GETS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MULTI_MUTATIONS"> |
| <h3>MULTI_MUTATIONS</h3> |
| <div class="member-signature"><span class="modifiers">private static final</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/ipc/RpcServer.html#line-94">MULTI_MUTATIONS</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.MULTI_MUTATIONS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MULTI_SERVICE_CALLS"> |
| <h3>MULTI_SERVICE_CALLS</h3> |
| <div class="member-signature"><span class="modifiers">private static final</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/ipc/RpcServer.html#line-95">MULTI_SERVICE_CALLS</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.MULTI_SERVICE_CALLS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="authorize"> |
| <h3>authorize</h3> |
| <div class="member-signature"><span class="modifiers">private final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-97">authorize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOnlineLogProviderEnabled"> |
| <h3>isOnlineLogProviderEnabled</h3> |
| <div class="member-signature"><span class="modifiers">private volatile</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-98">isOnlineLogProviderEnabled</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isSecurityEnabled"> |
| <h3>isSecurityEnabled</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-99">isSecurityEnabled</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CURRENT_VERSION"> |
| <h3>CURRENT_VERSION</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">byte</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-101">CURRENT_VERSION</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.CURRENT_VERSION">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FALLBACK_TO_INSECURE_CLIENT_AUTH"> |
| <h3>FALLBACK_TO_INSECURE_CLIENT_AUTH</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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/ipc/RpcServer.html#line-106">FALLBACK_TO_INSECURE_CLIENT_AUTH</a></span></div> |
| <div class="block">Whether we allow a fallback to SIMPLE auth for insecure clients when security is enabled.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.FALLBACK_TO_INSECURE_CLIENT_AUTH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER"> |
| <h3>DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-112">DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER</a></span></div> |
| <div class="block">How many calls/handler are allowed in the queue.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.DEFAULT_MAX_CALLQUEUE_LENGTH_PER_HANDLER">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cellBlockBuilder"> |
| <h3>cellBlockBuilder</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="CellBlockBuilder.html" title="class in org.apache.hadoop.hbase.ipc">CellBlockBuilder</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-114">cellBlockBuilder</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="AUTH_FAILED_FOR"> |
| <h3>AUTH_FAILED_FOR</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-116">AUTH_FAILED_FOR</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.AUTH_FAILED_FOR">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="AUTH_SUCCESSFUL_FOR"> |
| <h3>AUTH_SUCCESSFUL_FOR</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-117">AUTH_SUCCESSFUL_FOR</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.AUTH_SUCCESSFUL_FOR">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="AUDITLOG"> |
| <h3>AUDITLOG</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">org.slf4j.Logger</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-118">AUDITLOG</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="secretManager"> |
| <h3>secretManager</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.hadoop.security.token.SecretManager<org.apache.hadoop.security.token.TokenIdentifier></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-120">secretManager</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="saslProps"> |
| <h3>saslProps</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<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>,<wbr><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/ipc/RpcServer.html#line-121">saslProps</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="serverPrincipal"> |
| <h3>serverPrincipal</h3> |
| <div class="member-signature"><span class="modifiers">protected final</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/ipc/RpcServer.html#line-122">serverPrincipal</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="authManager"> |
| <h3>authManager</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">org.apache.hadoop.security.authorize.ServiceAuthorizationManager</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-124">authManager</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="CurCall"> |
| <h3>CurCall</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ThreadLocal.html" title="class or interface in java.lang" class="external-link">ThreadLocal</a><<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-129">CurCall</a></span></div> |
| <div class="block">This is set to Call object before Handler invokes an RPC and ybdie after the call returns.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MONITORED_RPC"> |
| <h3>MONITORED_RPC</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/ThreadLocal.html" title="class or interface in java.lang" class="external-link">ThreadLocal</a><<a href="../monitoring/MonitoredRPCHandler.html" title="interface in org.apache.hadoop.hbase.monitoring">MonitoredRPCHandler</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-132">MONITORED_RPC</a></span></div> |
| <div class="block">Keeps MonitoredRPCHandler per handler thread.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="bindAddress"> |
| <h3>bindAddress</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-134">bindAddress</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="metrics"> |
| <h3>metrics</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="MetricsHBaseServer.html" title="class in org.apache.hadoop.hbase.ipc">MetricsHBaseServer</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-136">metrics</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="conf"> |
| <h3>conf</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-138">conf</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxQueueSizeInBytes"> |
| <h3>maxQueueSizeInBytes</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">long</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-150">maxQueueSizeInBytes</a></span></div> |
| <div class="block">Maximum size in bytes of the currently queued and running Calls. If a new Call puts us over |
| this size, then we will reject the call (after parsing it though). It will go back to the |
| client and client will retry. Set this size with "hbase.ipc.server.max.callqueue.size". The |
| call queue size gets incremented after we parse a call and before we add it to the queue of |
| calls for the scheduler to use. It get decremented after we have 'run' the Call. The current |
| size is kept in <a href="#callQueueSizeInBytes"><code>callQueueSizeInBytes</code></a>.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#callQueueSizeInBytes"><code>callQueueSizeInBytes</code></a></li> |
| <li><a href="#DEFAULT_MAX_CALLQUEUE_SIZE"><code>DEFAULT_MAX_CALLQUEUE_SIZE</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_MAX_CALLQUEUE_SIZE"> |
| <h3>DEFAULT_MAX_CALLQUEUE_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-151">DEFAULT_MAX_CALLQUEUE_SIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.DEFAULT_MAX_CALLQUEUE_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="callQueueSizeInBytes"> |
| <h3>callQueueSizeInBytes</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/concurrent/atomic/LongAdder.html" title="class or interface in java.util.concurrent.atomic" class="external-link">LongAdder</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-157">callQueueSizeInBytes</a></span></div> |
| <div class="block">This is a running count of the size in bytes of all outstanding calls whether currently |
| executing or queued waiting to be run.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tcpNoDelay"> |
| <h3>tcpNoDelay</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-159">tcpNoDelay</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tcpKeepAlive"> |
| <h3>tcpKeepAlive</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-160">tcpKeepAlive</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="running"> |
| <h3>running</h3> |
| <div class="member-signature"><span class="modifiers">volatile</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-167">running</a></span></div> |
| <div class="block">This flag is used to indicate to sub threads when they should go down. When we call |
| <a href="RpcServerInterface.html#start()"><code>RpcServerInterface.start()</code></a>, all threads started will consult this flag on whether they should keep going. |
| It is set to false when <a href="RpcServerInterface.html#stop()"><code>RpcServerInterface.stop()</code></a> is called.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="started"> |
| <h3>started</h3> |
| <div class="member-signature"><span class="modifiers">volatile</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-173">started</a></span></div> |
| <div class="block">This flag is set to true after all threads are up and 'running' and the server is then opened |
| for business by the call to <a href="RpcServerInterface.html#start()"><code>RpcServerInterface.start()</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="authTokenSecretMgr"> |
| <h3>authTokenSecretMgr</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../security/token/AuthenticationTokenSecretManager.html" title="class in org.apache.hadoop.hbase.security.token">AuthenticationTokenSecretManager</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-175">authTokenSecretMgr</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="errorHandler"> |
| <h3>errorHandler</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="HBaseRPCErrorHandler.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRPCErrorHandler</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-177">errorHandler</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MAX_REQUEST_SIZE"> |
| <h3>MAX_REQUEST_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</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/ipc/RpcServer.html#line-179">MAX_REQUEST_SIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.MAX_REQUEST_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WARN_RESPONSE_TIME"> |
| <h3>WARN_RESPONSE_TIME</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-181">WARN_RESPONSE_TIME</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.WARN_RESPONSE_TIME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WARN_RESPONSE_SIZE"> |
| <h3>WARN_RESPONSE_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-182">WARN_RESPONSE_SIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.WARN_RESPONSE_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WARN_SCAN_RESPONSE_TIME"> |
| <h3>WARN_SCAN_RESPONSE_TIME</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-183">WARN_SCAN_RESPONSE_TIME</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.WARN_SCAN_RESPONSE_TIME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="WARN_SCAN_RESPONSE_SIZE"> |
| <h3>WARN_SCAN_RESPONSE_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-184">WARN_SCAN_RESPONSE_SIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.WARN_SCAN_RESPONSE_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="MIN_CLIENT_REQUEST_TIMEOUT"> |
| <h3>MIN_CLIENT_REQUEST_TIMEOUT</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-190">MIN_CLIENT_REQUEST_TIMEOUT</a></span></div> |
| <div class="block">Minimum allowable timeout (in milliseconds) in rpc request's header. This configuration exists |
| to prevent the rpc service regarding this request as timeout immediately.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.MIN_CLIENT_REQUEST_TIMEOUT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT"> |
| <h3>DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-191">DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.DEFAULT_MIN_CLIENT_REQUEST_TIMEOUT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_MAX_REQUEST_SIZE"> |
| <h3>DEFAULT_MAX_REQUEST_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">public static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-194">DEFAULT_MAX_REQUEST_SIZE</a></span></div> |
| <div class="block">Default value for above params</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.DEFAULT_MAX_REQUEST_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_WARN_RESPONSE_TIME"> |
| <h3>DEFAULT_WARN_RESPONSE_TIME</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-195">DEFAULT_WARN_RESPONSE_TIME</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.DEFAULT_WARN_RESPONSE_TIME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_WARN_RESPONSE_SIZE"> |
| <h3>DEFAULT_WARN_RESPONSE_SIZE</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-196">DEFAULT_WARN_RESPONSE_SIZE</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.DEFAULT_WARN_RESPONSE_SIZE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_TRACE_LOG_MAX_LENGTH"> |
| <h3>DEFAULT_TRACE_LOG_MAX_LENGTH</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-198">DEFAULT_TRACE_LOG_MAX_LENGTH</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.DEFAULT_TRACE_LOG_MAX_LENGTH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="TRACE_LOG_MAX_LENGTH"> |
| <h3>TRACE_LOG_MAX_LENGTH</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-199">TRACE_LOG_MAX_LENGTH</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.TRACE_LOG_MAX_LENGTH">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="KEY_WORD_TRUNCATED"> |
| <h3>KEY_WORD_TRUNCATED</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</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/ipc/RpcServer.html#line-200">KEY_WORD_TRUNCATED</a></span></div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.KEY_WORD_TRUNCATED">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="GSON"> |
| <h3>GSON</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">org.apache.hbase.thirdparty.com.google.gson.Gson</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-202">GSON</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="maxRequestSize"> |
| <h3>maxRequestSize</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-204">maxRequestSize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="warnResponseTime"> |
| <h3>warnResponseTime</h3> |
| <div class="member-signature"><span class="modifiers">protected volatile</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-205">warnResponseTime</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="warnResponseSize"> |
| <h3>warnResponseSize</h3> |
| <div class="member-signature"><span class="modifiers">protected volatile</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-206">warnResponseSize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="warnScanResponseTime"> |
| <h3>warnScanResponseTime</h3> |
| <div class="member-signature"><span class="modifiers">protected volatile</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-207">warnScanResponseTime</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="warnScanResponseSize"> |
| <h3>warnScanResponseSize</h3> |
| <div class="member-signature"><span class="modifiers">protected volatile</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-208">warnScanResponseSize</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="minClientRequestTimeout"> |
| <h3>minClientRequestTimeout</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-210">minClientRequestTimeout</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="server"> |
| <h3>server</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../Server.html" title="interface in org.apache.hadoop.hbase">Server</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-212">server</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="services"> |
| <h3>services</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-213">services</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="scheduler"> |
| <h3>scheduler</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-215">scheduler</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="userProvider"> |
| <h3>userProvider</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../security/UserProvider.html" title="class in org.apache.hadoop.hbase.security">UserProvider</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-217">userProvider</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="bbAllocator"> |
| <h3>bbAllocator</h3> |
| <div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type"><a href="../io/ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-219">bbAllocator</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="allowFallbackToSimpleAuth"> |
| <h3>allowFallbackToSimpleAuth</h3> |
| <div class="member-signature"><span class="modifiers">protected volatile</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-221">allowFallbackToSimpleAuth</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="rsRpcServices"> |
| <h3>rsRpcServices</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../regionserver/RSRpcServices.html" title="class in org.apache.hadoop.hbase.regionserver">RSRpcServices</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-227">rsRpcServices</a></span></div> |
| <div class="block">Used to get details for scan with a scanner_id<br/> |
| TODO try to figure out a better way and remove reference from regionserver package later.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="namedQueueRecorder"> |
| <h3>namedQueueRecorder</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../namequeues/NamedQueueRecorder.html" title="class in org.apache.hadoop.hbase.namequeues">NamedQueueRecorder</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-232">namedQueueRecorder</a></span></div> |
| <div class="block">Use to add online slowlog responses</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="NIO_BUFFER_LIMIT"> |
| <h3>NIO_BUFFER_LIMIT</h3> |
| <div class="member-signature"><span class="modifiers">protected static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-673">NIO_BUFFER_LIMIT</a></span></div> |
| <div class="block">When the read or write buffer size is larger than this limit, i/o will be done in chunks of |
| this size. Most RPC requests and responses would be be smaller.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcServer.NIO_BUFFER_LIMIT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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>(org.apache.hadoop.hbase.Server,java.lang.String,java.util.List,java.net.InetSocketAddress,org.apache.hadoop.conf.Configuration,org.apache.hadoop.hbase.ipc.RpcScheduler,boolean)"> |
| <h3>RpcServer</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-274">RpcServer</a></span><wbr><span class="parameters">(<a href="../Server.html" title="interface in org.apache.hadoop.hbase">Server</a> server, |
| <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> name, |
| <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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>> services, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetSocketAddress.html" title="class or interface in java.net" class="external-link">InetSocketAddress</a> bindAddress, |
| org.apache.hadoop.conf.Configuration conf, |
| <a href="RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a> scheduler, |
| boolean reservoirEnabled)</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> |
| <div class="block">Constructs a server listening on the named port and address.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>server</code> - hosting instance of <a href="../Server.html" title="interface in org.apache.hadoop.hbase"><code>Server</code></a>. We will do authentications if an |
| instance else pass null for no authentication check.</dd> |
| <dd><code>name</code> - Used keying this rpc servers' metrics and for naming the Listener |
| thread.</dd> |
| <dd><code>services</code> - A list of services.</dd> |
| <dd><code>bindAddress</code> - Where to listen</dd> |
| <dd><code>reservoirEnabled</code> - Enable ByteBufferPool or not.</dd> |
| <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> |
| </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="onConfigurationChange(org.apache.hadoop.conf.Configuration)"> |
| <h3>onConfigurationChange</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/ipc/RpcServer.html#line-317">onConfigurationChange</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration newConf)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../conf/ConfigurationObserver.html#onConfigurationChange(org.apache.hadoop.conf.Configuration)">ConfigurationObserver</a></code></span></div> |
| <div class="block">This method would be called by the <a href="../conf/ConfigurationManager.html" title="class in org.apache.hadoop.hbase.conf"><code>ConfigurationManager</code></a> object when the |
| <code>Configuration</code> object is reloaded from disk.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../conf/ConfigurationObserver.html#onConfigurationChange(org.apache.hadoop.conf.Configuration)">onConfigurationChange</a></code> in interface <code><a href="../conf/ConfigurationObserver.html" title="interface in org.apache.hadoop.hbase.conf">ConfigurationObserver</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="refreshSlowLogConfiguration(org.apache.hadoop.conf.Configuration)"> |
| <h3>refreshSlowLogConfiguration</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-329">refreshSlowLogConfiguration</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration newConf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getIsOnlineLogProviderEnabled(org.apache.hadoop.conf.Configuration)"> |
| <h3>getIsOnlineLogProviderEnabled</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-352">getIsOnlineLogProviderEnabled</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWarnResponseTime(org.apache.hadoop.conf.Configuration)"> |
| <h3>getWarnResponseTime</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-357">getWarnResponseTime</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWarnResponseSize(org.apache.hadoop.conf.Configuration)"> |
| <h3>getWarnResponseSize</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-361">getWarnResponseSize</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWarnScanResponseTime(org.apache.hadoop.conf.Configuration)"> |
| <h3>getWarnScanResponseTime</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-365">getWarnScanResponseTime</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getWarnScanResponseSize(org.apache.hadoop.conf.Configuration)"> |
| <h3>getWarnScanResponseSize</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-369">getWarnScanResponseSize</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="initReconfigurable(org.apache.hadoop.conf.Configuration)"> |
| <h3>initReconfigurable</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-373">initReconfigurable</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration confToLoad)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getConf()"> |
| <h3>getConf</h3> |
| <div class="member-signature"><span class="return-type">org.apache.hadoop.conf.Configuration</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-387">getConf</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isStarted()"> |
| <h3>isStarted</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/ipc/RpcServer.html#line-391">isStarted</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#isStarted()">isStarted</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="refreshAuthManager(org.apache.hadoop.conf.Configuration,org.apache.hadoop.security.authorize.PolicyProvider)"> |
| <h3>refreshAuthManager</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/ipc/RpcServer.html#line-396">refreshAuthManager</a></span><wbr><span class="parameters">(org.apache.hadoop.conf.Configuration conf, |
| org.apache.hadoop.security.authorize.PolicyProvider pp)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RpcServerInterface.html#refreshAuthManager(org.apache.hadoop.conf.Configuration,org.apache.hadoop.security.authorize.PolicyProvider)">RpcServerInterface</a></code></span></div> |
| <div class="block">Refresh authentication manager policy.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#refreshAuthManager(org.apache.hadoop.conf.Configuration,org.apache.hadoop.security.authorize.PolicyProvider)">refreshAuthManager</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createSecretManager()"> |
| <h3>createSecretManager</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="../security/token/AuthenticationTokenSecretManager.html" title="class in org.apache.hadoop.hbase.security.token">AuthenticationTokenSecretManager</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-407">createSecretManager</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSecretManager()"> |
| <h3>getSecretManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">org.apache.hadoop.security.token.SecretManager<? extends org.apache.hadoop.security.token.TokenIdentifier></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-417">getSecretManager</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setSecretManager(org.apache.hadoop.security.token.SecretManager)"> |
| <h3>setSecretManager</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/ipc/RpcServer.html#line-421">setSecretManager</a></span><wbr><span class="parameters">(org.apache.hadoop.security.token.SecretManager<? extends org.apache.hadoop.security.token.TokenIdentifier> secretManager)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="call(org.apache.hadoop.hbase.ipc.RpcCall,org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler)"> |
| <h3>call</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../util/Pair.html" title="class in org.apache.hadoop.hbase.util">Pair</a><org.apache.hbase.thirdparty.com.google.protobuf.Message,<wbr><a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-431">call</a></span><wbr><span class="parameters">(<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a> call, |
| <a href="../monitoring/MonitoredRPCHandler.html" title="interface in org.apache.hadoop.hbase.monitoring">MonitoredRPCHandler</a> status)</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> |
| <div class="block">This is a server side method, which is invoked over RPC. On success the return response has |
| protobuf response payload. On failure, the exception name and the stack trace are returned in |
| the protobuf response.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#call(org.apache.hadoop.hbase.ipc.RpcCall,org.apache.hadoop.hbase.monitoring.MonitoredRPCHandler)">call</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| <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="logResponse(org.apache.hbase.thirdparty.com.google.protobuf.Message,java.lang.String,java.lang.String,boolean,boolean,java.lang.String,long,int,int,long,long,long,java.lang.String)"> |
| <h3>logResponse</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-532">logResponse</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.com.google.protobuf.Message param, |
| <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> methodName, |
| <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> call, |
| boolean tooLarge, |
| boolean tooSlow, |
| <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> clientAddress, |
| long startTime, |
| int processingTime, |
| int qTime, |
| long responseSize, |
| long blockBytesScanned, |
| long fsReadTime, |
| <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> userName)</span></div> |
| <div class="block">Logs an RPC response to the LOG file, producing valid JSON objects for client Operations.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>param</code> - The parameters received in the call.</dd> |
| <dd><code>methodName</code> - The name of the method invoked</dd> |
| <dd><code>call</code> - The string representation of the call</dd> |
| <dd><code>tooLarge</code> - To indicate if the event is tooLarge</dd> |
| <dd><code>tooSlow</code> - To indicate if the event is tooSlow</dd> |
| <dd><code>clientAddress</code> - The address of the client who made this call.</dd> |
| <dd><code>startTime</code> - The time that the call was initiated, in ms.</dd> |
| <dd><code>processingTime</code> - The duration that the call took to run, in ms.</dd> |
| <dd><code>qTime</code> - The duration that the call spent on the queue prior to being |
| initiated, in ms.</dd> |
| <dd><code>responseSize</code> - The size in bytes of the response buffer.</dd> |
| <dd><code>blockBytesScanned</code> - The size of block bytes scanned to retrieve the response.</dd> |
| <dd><code>userName</code> - UserName of the current RPC Call</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTooSlow(org.apache.hadoop.hbase.ipc.RpcCall,int)"> |
| <h3>isTooSlow</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-595">isTooSlow</a></span><wbr><span class="parameters">(<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a> call, |
| int processingTime)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isTooLarge(org.apache.hadoop.hbase.ipc.RpcCall,long,long)"> |
| <h3>isTooLarge</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-602">isTooLarge</a></span><wbr><span class="parameters">(<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a> call, |
| long responseSize, |
| long responseBlockSize)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="truncateTraceLog(java.lang.String)"> |
| <h3>truncateTraceLog</h3> |
| <div class="member-signature"><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/ipc/RpcServer.html#line-616">truncateTraceLog</a></span><wbr><span class="parameters">(<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> strParam)</span></div> |
| <div class="block">Truncate to number of chars decided by conf hbase.ipc.trace.log.max.length if TRACE is on else |
| to 150 chars Refer to Jira HBASE-20826 and HBASE-20942</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>strParam</code> - stringifiedParam to be truncated</dd> |
| <dt>Returns:</dt> |
| <dd>truncated trace log string</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setErrorHandler(org.apache.hadoop.hbase.ipc.HBaseRPCErrorHandler)"> |
| <h3>setErrorHandler</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/ipc/RpcServer.html#line-631">setErrorHandler</a></span><wbr><span class="parameters">(<a href="HBaseRPCErrorHandler.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRPCErrorHandler</a> handler)</span></div> |
| <div class="block">Set the handler for calling out of RPC for error conditions.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#setErrorHandler(org.apache.hadoop.hbase.ipc.HBaseRPCErrorHandler)">setErrorHandler</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>handler</code> - the handler implementation</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getErrorHandler()"> |
| <h3>getErrorHandler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="HBaseRPCErrorHandler.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRPCErrorHandler</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-636">getErrorHandler</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#getErrorHandler()">getErrorHandler</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMetrics()"> |
| <h3>getMetrics</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="MetricsHBaseServer.html" title="class in org.apache.hadoop.hbase.ipc">MetricsHBaseServer</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-644">getMetrics</a></span>()</div> |
| <div class="block">Returns the metrics instance for reporting RPC call statistics</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#getMetrics()">getMetrics</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="addCallSize(long)"> |
| <h3>addCallSize</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/ipc/RpcServer.html#line-649">addCallSize</a></span><wbr><span class="parameters">(long diff)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RpcServerInterface.html#addCallSize(long)">RpcServerInterface</a></code></span></div> |
| <div class="block">Add/subtract from the current size of all outstanding calls. Called on setup of a call to add |
| call total size and then again at end of a call to remove the call size.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#addCallSize(long)">addCallSize</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>diff</code> - Change (plus or minus)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="authorize(org.apache.hadoop.security.UserGroupInformation,org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader,java.net.InetAddress)"> |
| <h3>authorize</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/ipc/RpcServer.html#line-661">authorize</a></span><wbr><span class="parameters">(org.apache.hadoop.security.UserGroupInformation user, |
| org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.ConnectionHeader connection, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a> addr)</span> |
| throws <span class="exceptions">org.apache.hadoop.security.authorize.AuthorizationException</span></div> |
| <div class="block">Authorize the incoming client connection.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>user</code> - client user</dd> |
| <dd><code>connection</code> - incoming connection</dd> |
| <dd><code>addr</code> - InetAddress of incoming connection</dd> |
| <dt>Throws:</dt> |
| <dd><code>org.apache.hadoop.security.authorize.AuthorizationException</code> - when the client isn't authorized to talk the protocol</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="channelRead(java.nio.channels.ReadableByteChannel,java.nio.ByteBuffer)"> |
| <h3>channelRead</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-687">channelRead</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels" class="external-link">ReadableByteChannel</a> channel, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buffer)</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> |
| <div class="block">This is a wrapper around |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/ReadableByteChannel.html#read(java.nio.ByteBuffer)" title="class or interface in java.nio.channels" class="external-link"><code>ReadableByteChannel.read(java.nio.ByteBuffer)</code></a>. If the amount of data |
| is large, it writes to channel in smaller chunks. This is to avoid jdk from creating many |
| direct buffers as the size of ByteBuffer increases. There should not be any performance |
| degredation.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>channel</code> - writable byte channel to write on</dd> |
| <dd><code>buffer</code> - buffer to write</dd> |
| <dt>Returns:</dt> |
| <dd>number of bytes written</dd> |
| <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> - e</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/ReadableByteChannel.html#read(java.nio.ByteBuffer)" title="class or interface in java.nio.channels" class="external-link"><code>ReadableByteChannel.read(java.nio.ByteBuffer)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="channelIO(java.nio.channels.ReadableByteChannel,java.nio.channels.WritableByteChannel,java.nio.ByteBuffer)"> |
| <h3>channelIO</h3> |
| <div class="member-signature"><span class="modifiers">private static</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-708">channelIO</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/ReadableByteChannel.html" title="class or interface in java.nio.channels" class="external-link">ReadableByteChannel</a> readCh, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/channels/WritableByteChannel.html" title="class or interface in java.nio.channels" class="external-link">WritableByteChannel</a> writeCh, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/nio/ByteBuffer.html" title="class or interface in java.nio" class="external-link">ByteBuffer</a> buf)</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> |
| <div class="block">Helper for <a href="#channelRead(java.nio.channels.ReadableByteChannel,java.nio.ByteBuffer)"><code>channelRead(java.nio.channels.ReadableByteChannel, java.nio.ByteBuffer)</code></a>. |
| Only one of readCh or writeCh should be non-null.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>readCh</code> - read channel</dd> |
| <dd><code>writeCh</code> - write channel</dd> |
| <dd><code>buf</code> - buffer to read or write into/out of</dd> |
| <dt>Returns:</dt> |
| <dd>bytes written</dd> |
| <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> - e</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list-long"> |
| <li><a href="#channelRead(java.nio.channels.ReadableByteChannel,java.nio.ByteBuffer)"><code>channelRead(java.nio.channels.ReadableByteChannel, java.nio.ByteBuffer)</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCurrentCall()"> |
| <h3>getCurrentCall</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-740">getCurrentCall</a></span>()</div> |
| <div class="block">Needed for features such as delayed calls. We need to be able to store the current call so that |
| we can complete it later or ask questions of what is supported by the current ongoing call.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>An RpcCallContext backed by the currently ongoing call (gotten from a thread local)</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCurrentServerCallWithCellScanner()"> |
| <h3>getCurrentServerCallWithCellScanner</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="ServerCall.html" title="class in org.apache.hadoop.hbase.ipc">ServerCall</a><?>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-750">getCurrentServerCallWithCellScanner</a></span>()</div> |
| <div class="block">Just return the current rpc call if it is a <a href="ServerCall.html" title="class in org.apache.hadoop.hbase.ipc"><code>ServerCall</code></a> and also has <a href="../CellScanner.html" title="interface in org.apache.hadoop.hbase"><code>CellScanner</code></a> |
| attached. |
| <p/> |
| Mainly used for reference counting as <a href="../CellScanner.html" title="interface in org.apache.hadoop.hbase"><code>CellScanner</code></a> may reference non heap memory.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isInRpcCallContext()"> |
| <h3>isInRpcCallContext</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-755">isInRpcCallContext</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="unsetCurrentCall()"> |
| <h3>unsetCurrentCall</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-766">unsetCurrentCall</a></span>()</div> |
| <div class="block">Used by <a href="../procedure2/store/region/RegionProcedureStore.html" title="class in org.apache.hadoop.hbase.procedure2.store.region"><code>RegionProcedureStore</code></a>. For |
| master's rpc call, it may generate new procedure and mutate the region which store procedure. |
| There are some check about rpc when mutate region, such as rpc timeout check. So unset the rpc |
| call to avoid the rpc check.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the currently ongoing rpc call</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCurrentCall(org.apache.hadoop.hbase.ipc.RpcCall)"> |
| <h3>setCurrentCall</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-776">setCurrentCall</a></span><wbr><span class="parameters">(<a href="RpcCall.html" title="interface in org.apache.hadoop.hbase.ipc">RpcCall</a> rpcCall)</span></div> |
| <div class="block">Used by <a href="../procedure2/store/region/RegionProcedureStore.html" title="class in org.apache.hadoop.hbase.procedure2.store.region"><code>RegionProcedureStore</code></a>. Set the |
| rpc call back after mutate region.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestUser()"> |
| <h3>getRequestUser</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-785">getRequestUser</a></span>()</div> |
| <div class="block">Returns the user credentials associated with the current RPC request or not present if no |
| credentials were provided.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>A User</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getNumOpenConnections()"> |
| <h3>getNumOpenConnections</h3> |
| <div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-794">getNumOpenConnections</a></span>()</div> |
| <div class="block">The number of open RPC conections</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>the number of open rpc connections</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestUserName()"> |
| <h3>getRequestUserName</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<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/ipc/RpcServer.html#line-800">getRequestUserName</a></span>()</div> |
| <div class="block">Returns the username for any user associated with the current RPC request or not present if no |
| user is set.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteAddress()"> |
| <h3>getRemoteAddress</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-808">getRemoteAddress</a></span>()</div> |
| <div class="block">Returns the address of the remote client associated with the current RPC request or not present |
| if no address is set.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServiceAndInterface(java.util.List,java.lang.String)"> |
| <h3>getServiceAndInterface</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-817">getServiceAndInterface</a></span><wbr><span class="parameters">(<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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>> services, |
| <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> serviceName)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>serviceName</code> - Some arbitrary string that represents a 'service'.</dd> |
| <dd><code>services</code> - Available service instances</dd> |
| <dt>Returns:</dt> |
| <dd>Matching BlockingServiceAndInterface pair</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServiceInterface(java.util.List,java.lang.String)"> |
| <h3>getServiceInterface</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><?></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-832">getServiceInterface</a></span><wbr><span class="parameters">(<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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>> services, |
| <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> serviceName)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>serviceName</code> - Some arbitrary string that represents a 'service'.</dd> |
| <dd><code>services</code> - Available services and their service interfaces.</dd> |
| <dt>Returns:</dt> |
| <dd>Service interface class for <code>serviceName</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getService(java.util.List,java.lang.String)"> |
| <h3>getService</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">org.apache.hbase.thirdparty.com.google.protobuf.BlockingService</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-843">getService</a></span><wbr><span class="parameters">(<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><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>> services, |
| <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> serviceName)</span></div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>serviceName</code> - Some arbitrary string that represents a 'service'.</dd> |
| <dd><code>services</code> - Available services and their service interfaces.</dd> |
| <dt>Returns:</dt> |
| <dd>BlockingService that goes with the passed <code>serviceName</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getStatus()"> |
| <h3>getStatus</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type"><a href="../monitoring/MonitoredRPCHandler.html" title="interface in org.apache.hadoop.hbase.monitoring">MonitoredRPCHandler</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-849">getStatus</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRemoteIp()"> |
| <h3>getRemoteIp</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/net/InetAddress.html" title="class or interface in java.net" class="external-link">InetAddress</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-864">getRemoteIp</a></span>()</div> |
| <div class="block">Returns the remote side ip address when invoked inside an RPC Returns null incase of an error.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getScheduler()"> |
| <h3>getScheduler</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="RpcScheduler.html" title="class in org.apache.hadoop.hbase.ipc">RpcScheduler</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-872">getScheduler</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#getScheduler()">getScheduler</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getByteBuffAllocator()"> |
| <h3>getByteBuffAllocator</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../io/ByteBuffAllocator.html" title="class in org.apache.hadoop.hbase.io">ByteBuffAllocator</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-877">getByteBuffAllocator</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RpcServerInterface.html#getByteBuffAllocator()">RpcServerInterface</a></code></span></div> |
| <div class="block">Allocator to allocate/free the ByteBuffers, those ByteBuffers can be on-heap or off-heap.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#getByteBuffAllocator()">getByteBuffAllocator</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>byte buffer allocator</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRsRpcServices(org.apache.hadoop.hbase.regionserver.RSRpcServices)"> |
| <h3>setRsRpcServices</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/ipc/RpcServer.html#line-882">setRsRpcServices</a></span><wbr><span class="parameters">(<a href="../regionserver/RSRpcServices.html" title="class in org.apache.hadoop.hbase.regionserver">RSRpcServices</a> rsRpcServices)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#setRsRpcServices(org.apache.hadoop.hbase.regionserver.RSRpcServices)">setRsRpcServices</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setNamedQueueRecorder(org.apache.hadoop.hbase.namequeues.NamedQueueRecorder)"> |
| <h3>setNamedQueueRecorder</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/ipc/RpcServer.html#line-887">setNamedQueueRecorder</a></span><wbr><span class="parameters">(<a href="../namequeues/NamedQueueRecorder.html" title="class in org.apache.hadoop.hbase.namequeues">NamedQueueRecorder</a> namedQueueRecorder)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="RpcServerInterface.html#setNamedQueueRecorder(org.apache.hadoop.hbase.namequeues.NamedQueueRecorder)">RpcServerInterface</a></code></span></div> |
| <div class="block">Set Online SlowLog Provider</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="RpcServerInterface.html#setNamedQueueRecorder(org.apache.hadoop.hbase.namequeues.NamedQueueRecorder)">setNamedQueueRecorder</a></code> in interface <code><a href="RpcServerInterface.html" title="interface in org.apache.hadoop.hbase.ipc">RpcServerInterface</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>namedQueueRecorder</code> - instance of <a href="../namequeues/NamedQueueRecorder.html" title="class in org.apache.hadoop.hbase.namequeues"><code>NamedQueueRecorder</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="needAuthorization()"> |
| <h3>needAuthorization</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-892">needAuthorization</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getServices()"> |
| <h3>getServices</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/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="RpcServer.BlockingServiceAndInterface.html" title="class in org.apache.hadoop.hbase.ipc">RpcServer.BlockingServiceAndInterface</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcServer.html#line-896">getServices</a></span>()</div> |
| </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> |
