| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RpcClient (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, interface: RpcClient"> |
| <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/RpcClient.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </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>Constr | </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="Interface RpcClient" class="title">Interface RpcClient</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractRpcClient.html" title="class in org.apache.hadoop.hbase.ipc">AbstractRpcClient</a></code>, <code><a href="BlockingRpcClient.html" title="class in org.apache.hadoop.hbase.ipc">BlockingRpcClient</a></code>, <code><a href="NettyRpcClient.html" title="class in org.apache.hadoop.hbase.ipc">NettyRpcClient</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-31">RpcClient</a></span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></span></div> |
| <div class="block">Interface for RpcClient implementations so ConnectionManager can handle it.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>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="#DEFAULT_CODEC_CLASS" class="member-name-link">DEFAULT_CODEC_CLASS</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_SOCKET_TIMEOUT_CONNECT" class="member-name-link">DEFAULT_SOCKET_TIMEOUT_CONNECT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#DEFAULT_SOCKET_TIMEOUT_READ" class="member-name-link">DEFAULT_SOCKET_TIMEOUT_READ</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_SOCKET_TIMEOUT_WRITE" class="member-name-link">DEFAULT_SOCKET_TIMEOUT_WRITE</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final int</code></div> |
| <div class="col-second even-row-color"><code><a href="#FAILED_SERVER_EXPIRY_DEFAULT" class="member-name-link">FAILED_SERVER_EXPIRY_DEFAULT</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="#FAILED_SERVER_EXPIRY_KEY" class="member-name-link">FAILED_SERVER_EXPIRY_KEY</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-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 even-row-color"><code><a href="#IDLE_TIME" class="member-name-link">IDLE_TIME</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final boolean</code></div> |
| <div class="col-second odd-row-color"><code><a href="#IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT" class="member-name-link">IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-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 even-row-color"><code><a href="#IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY" class="member-name-link">IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY</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="#PING_CALL_ID" class="member-name-link">PING_CALL_ID</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>static final byte[]</code></div> |
| <div class="col-second even-row-color"><code><a href="#REGISTRY_PREAMBLE_HEADER" class="member-name-link">REGISTRY_PREAMBLE_HEADER</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>static final byte[]</code></div> |
| <div class="col-second odd-row-color"><code><a href="#SECURITY_PREAMBLE_HEADER" class="member-name-link">SECURITY_PREAMBLE_HEADER</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-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 even-row-color"><code><a href="#SOCKET_TIMEOUT_CONNECT" class="member-name-link">SOCKET_TIMEOUT_CONNECT</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="#SOCKET_TIMEOUT_READ" class="member-name-link">SOCKET_TIMEOUT_READ</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">How long we wait when we wait for an answer.</div> |
| </div> |
| <div class="col-first even-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 even-row-color"><code><a href="#SOCKET_TIMEOUT_WRITE" class="member-name-link">SOCKET_TIMEOUT_WRITE</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="#SPECIFIC_WRITE_THREAD" class="member-name-link">SPECIFIC_WRITE_THREAD</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-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></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-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#cancelConnections(org.apache.hadoop.hbase.ServerName)" class="member-name-link">cancelConnections</a><wbr>(<a href="../ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> sn)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Interrupt the connections to the given server.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Stop all threads related to this client.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createBlockingRpcChannel(org.apache.hadoop.hbase.ServerName,org.apache.hadoop.hbase.security.User,int)" class="member-name-link">createBlockingRpcChannel</a><wbr>(<a href="../ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> sn, |
| <a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user, |
| int rpcTimeout)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a "channel" that can be used by a blocking protobuf service.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createRpcChannel(org.apache.hadoop.hbase.ServerName,org.apache.hadoop.hbase.security.User,int)" class="member-name-link">createRpcChannel</a><wbr>(<a href="../ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> sn, |
| <a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user, |
| int rpcTimeout)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates a "channel" that can be used by a protobuf service.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#hasCellBlockSupport()" class="member-name-link">hasCellBlockSupport</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Return true when this client uses a <a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec"><code>Codec</code></a> and so supports |
| cell blocks.</div> |
| </div> |
| </div> |
| </div> |
| </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="FAILED_SERVER_EXPIRY_KEY"> |
| <h3>FAILED_SERVER_EXPIRY_KEY</h3> |
| <div class="member-signature"><span class="modifiers">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/RpcClient.html#line-33">FAILED_SERVER_EXPIRY_KEY</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.RpcClient.FAILED_SERVER_EXPIRY_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="FAILED_SERVER_EXPIRY_DEFAULT"> |
| <h3>FAILED_SERVER_EXPIRY_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-34">FAILED_SERVER_EXPIRY_DEFAULT</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.RpcClient.FAILED_SERVER_EXPIRY_DEFAULT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="IDLE_TIME"> |
| <h3>IDLE_TIME</h3> |
| <div class="member-signature"><span class="modifiers">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/RpcClient.html#line-35">IDLE_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.RpcClient.IDLE_TIME">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY"> |
| <h3>IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY</h3> |
| <div class="member-signature"><span class="modifiers">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/RpcClient.html#line-36">IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY</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.RpcClient.IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT"> |
| <h3>IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-38">IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT</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.RpcClient.IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SPECIFIC_WRITE_THREAD"> |
| <h3>SPECIFIC_WRITE_THREAD</h3> |
| <div class="member-signature"><span class="modifiers">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/RpcClient.html#line-39">SPECIFIC_WRITE_THREAD</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.RpcClient.SPECIFIC_WRITE_THREAD">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_CODEC_CLASS"> |
| <h3>DEFAULT_CODEC_CLASS</h3> |
| <div class="member-signature"><span class="modifiers">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/RpcClient.html#line-40">DEFAULT_CODEC_CLASS</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.RpcClient.DEFAULT_CODEC_CLASS">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SOCKET_TIMEOUT_CONNECT"> |
| <h3>SOCKET_TIMEOUT_CONNECT</h3> |
| <div class="member-signature"><span class="modifiers">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/RpcClient.html#line-42">SOCKET_TIMEOUT_CONNECT</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.RpcClient.SOCKET_TIMEOUT_CONNECT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SOCKET_TIMEOUT_READ"> |
| <h3>SOCKET_TIMEOUT_READ</h3> |
| <div class="member-signature"><span class="modifiers">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/RpcClient.html#line-47">SOCKET_TIMEOUT_READ</a></span></div> |
| <div class="block">How long we wait when we wait for an answer. It's not the operation time, it's the time we wait |
| when we start to receive an answer, when the remote write starts to send the data.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.RpcClient.SOCKET_TIMEOUT_READ">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SOCKET_TIMEOUT_WRITE"> |
| <h3>SOCKET_TIMEOUT_WRITE</h3> |
| <div class="member-signature"><span class="modifiers">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/RpcClient.html#line-48">SOCKET_TIMEOUT_WRITE</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.RpcClient.SOCKET_TIMEOUT_WRITE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_SOCKET_TIMEOUT_CONNECT"> |
| <h3>DEFAULT_SOCKET_TIMEOUT_CONNECT</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-49">DEFAULT_SOCKET_TIMEOUT_CONNECT</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.RpcClient.DEFAULT_SOCKET_TIMEOUT_CONNECT">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_SOCKET_TIMEOUT_READ"> |
| <h3>DEFAULT_SOCKET_TIMEOUT_READ</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-50">DEFAULT_SOCKET_TIMEOUT_READ</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.RpcClient.DEFAULT_SOCKET_TIMEOUT_READ">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="DEFAULT_SOCKET_TIMEOUT_WRITE"> |
| <h3>DEFAULT_SOCKET_TIMEOUT_WRITE</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-51">DEFAULT_SOCKET_TIMEOUT_WRITE</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.RpcClient.DEFAULT_SOCKET_TIMEOUT_WRITE">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="PING_CALL_ID"> |
| <h3>PING_CALL_ID</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-55">PING_CALL_ID</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.RpcClient.PING_CALL_ID">Constant Field Values</a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="REGISTRY_PREAMBLE_HEADER"> |
| <h3>REGISTRY_PREAMBLE_HEADER</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-57">REGISTRY_PREAMBLE_HEADER</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SECURITY_PREAMBLE_HEADER"> |
| <h3>SECURITY_PREAMBLE_HEADER</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type">byte[]</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-59">SECURITY_PREAMBLE_HEADER</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createBlockingRpcChannel(org.apache.hadoop.hbase.ServerName,org.apache.hadoop.hbase.security.User,int)"> |
| <h3>createBlockingRpcChannel</h3> |
| <div class="member-signature"><span class="return-type">org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-69">createBlockingRpcChannel</a></span><wbr><span class="parameters">(<a href="../ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> sn, |
| <a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user, |
| int rpcTimeout)</span></div> |
| <div class="block">Creates a "channel" that can be used by a blocking protobuf service. Useful setting up protobuf |
| blocking stubs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sn</code> - server name describing location of server</dd> |
| <dd><code>user</code> - which is to use the connection</dd> |
| <dd><code>rpcTimeout</code> - default rpc operation timeout</dd> |
| <dt>Returns:</dt> |
| <dd>A blocking rpc channel that goes via this rpc client instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createRpcChannel(org.apache.hadoop.hbase.ServerName,org.apache.hadoop.hbase.security.User,int)"> |
| <h3>createRpcChannel</h3> |
| <div class="member-signature"><span class="return-type">org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-78">createRpcChannel</a></span><wbr><span class="parameters">(<a href="../ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> sn, |
| <a href="../security/User.html" title="class in org.apache.hadoop.hbase.security">User</a> user, |
| int rpcTimeout)</span></div> |
| <div class="block">Creates a "channel" that can be used by a protobuf service. Useful setting up protobuf stubs.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sn</code> - server name describing location of server</dd> |
| <dd><code>user</code> - which is to use the connection</dd> |
| <dd><code>rpcTimeout</code> - default rpc operation timeout</dd> |
| <dt>Returns:</dt> |
| <dd>A rpc channel that goes via this rpc client instance.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cancelConnections(org.apache.hadoop.hbase.ServerName)"> |
| <h3>cancelConnections</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-88">cancelConnections</a></span><wbr><span class="parameters">(<a href="../ServerName.html" title="class in org.apache.hadoop.hbase">ServerName</a> sn)</span></div> |
| <div class="block">Interrupt the connections to the given server. This should be called if the server is known as |
| actually dead. This will not prevent current operation to be retried, and, depending on their |
| own behavior, they may retry on the same server. This can be a feature, for example at startup. |
| In any case, they're likely to get connection refused (if the process died) or no route to |
| host: i.e. their next retries should be faster and with a safe exception.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>sn</code> - server location to cancel connections of</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-93">close</a></span>()</div> |
| <div class="block">Stop all threads related to this client. No further calls may be made using this client.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasCellBlockSupport()"> |
| <h3>hasCellBlockSupport</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/RpcClient.html#line-100">hasCellBlockSupport</a></span>()</div> |
| <div class="block">Return true when this client uses a <a href="../codec/Codec.html" title="interface in org.apache.hadoop.hbase.codec"><code>Codec</code></a> and so supports |
| cell blocks.</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> |
