| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>HBaseRpcControllerImpl (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: HBaseRpcControllerImpl"> |
| <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/HBaseRpcControllerImpl.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 HBaseRpcControllerImpl" class="title">Class HBaseRpcControllerImpl</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.HBaseRpcControllerImpl</div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a></code>, <code><a href="../ExtendedCellScannable.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScannable</a></code>, <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code>, <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="annotations">@Private |
| </span><span class="modifiers">public class </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-39">HBaseRpcControllerImpl</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="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></span></div> |
| <div class="block">Get instances via <a href="RpcControllerFactory.html" title="class in org.apache.hadoop.hbase.ipc"><code>RpcControllerFactory</code></a> on client-side.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="RpcControllerFactory.html" title="class in org.apache.hadoop.hbase.ipc"><code>RpcControllerFactory</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </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="inherited-list"> |
| <h2 id="nested-classes-inherited-from-class-org.apache.hadoop.hbase.ipc.HBaseRpcController">Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.ipc.<a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></h2> |
| <code><a href="HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a></code></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>private <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#callTimeout" class="member-name-link">callTimeout</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">The time, in ms before the call should expire.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private 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><org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>>></code></div> |
| <div class="col-second odd-row-color"><code><a href="#cancellationCbs" class="member-name-link">cancellationCbs</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#cancelled" class="member-name-link">cancelled</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#cellScanner" class="member-name-link">cellScanner</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">They are optionally set on construction, cleared after we make the call, and then optionally |
| set on response with the result.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private boolean</code></div> |
| <div class="col-second even-row-color"><code><a href="#done" class="member-name-link">done</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <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></div> |
| <div class="col-second odd-row-color"><code><a href="#exception" class="member-name-link">exception</a></code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-first even-row-color"><code>private int</code></div> |
| <div class="col-second even-row-color"><code><a href="#priority" class="member-name-link">priority</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block">Priority to set on this request.</div> |
| </div> |
| <div class="col-first odd-row-color"><code>private <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#regionInfo" class="member-name-link">regionInfo</a></code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Rpc target Region's RegionInfo we are going against.</div> |
| </div> |
| <div class="col-first even-row-color"><code>private <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>byte[]></code></div> |
| <div class="col-second even-row-color"><code><a href="#requestAttributes" class="member-name-link">requestAttributes</a></code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-first odd-row-color"><code>private <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></div> |
| <div class="col-second odd-row-color"><code><a href="#tableName" class="member-name-link">tableName</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()" class="member-name-link">HBaseRpcControllerImpl</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.client.RegionInfo,java.util.List)" class="member-name-link">HBaseRpcControllerImpl</a><wbr>(<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| <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="../ExtendedCellScannable.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScannable</a>> cellIterables)</code></div> |
| <div class="col-last odd-row-color"> </div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.ExtendedCellScanner)" class="member-name-link">HBaseRpcControllerImpl</a><wbr>(<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| <a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a> cellScanner)</code></div> |
| <div class="col-last even-row-color"> </div> |
| <div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(org.apache.hadoop.hbase.ExtendedCellScanner)" class="member-name-link">HBaseRpcControllerImpl</a><wbr>(<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a> cellScanner)</code></div> |
| <div class="col-last odd-row-color"> |
| <div class="block">Used server-side.</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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../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="#cellScanner()" class="member-name-link">cellScanner</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 One-shot cell scanner (you cannot back it up and restart)</div> |
| </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/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-tab2 method-summary-table-tab4"><code><a href="#errorText()" class="member-name-link">errorText</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#failed()" class="member-name-link">failed</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>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getCallTimeout()" class="member-name-link">getCallTimeout</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="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></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getFailed()" class="member-name-link">getFailed</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Return the failed exception, null if not failed.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>int</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getPriority()" class="member-name-link">getPriority</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns The priority of this request</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRegionInfo()" class="member-name-link">getRegionInfo</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 Target Region's RegionInfo or null if not available or pertinent.</div> |
| </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/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>byte[]></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRequestAttributes()" class="member-name-link">getRequestAttributes</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the map of request attributes</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getTableName()" class="member-name-link">getTableName</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 Region's table name or null if not available or pertinent.</div> |
| </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="#hasCallTimeout()" class="member-name-link">hasCallTimeout</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>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#hasRegionInfo()" class="member-name-link">hasRegionInfo</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Returns True if this Controller is carrying the RPC target Region's RegionInfo.</div> |
| </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="#isCanceled()" class="member-name-link">isCanceled</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="#notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback)" class="member-name-link">notifyOnCancel</a><wbr>(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<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>> callback)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">A little different from the basic RpcController: |
| |
| You can register multiple callbacks to an <code>HBaseRpcController</code>. |
| The callback will not be called if the rpc call is finished without any cancellation. |
| You can call me at client side also. |
| </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="#notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback,org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)" class="member-name-link">notifyOnCancel</a><wbr>(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<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>> callback, |
| <a href="HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a> action)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">If not cancelled, add the callback to cancellation callback list.</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="#reset()" class="member-name-link">reset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setCallTimeout(int)" class="member-name-link">setCallTimeout</a><wbr>(int callTimeout)</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="#setCellScanner(org.apache.hadoop.hbase.ExtendedCellScanner)" class="member-name-link">setCellScanner</a><wbr>(<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a> cellScanner)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Only used to send cells to rpc server, the returned cells should be set by |
| <a href="HBaseRpcController.html#setDone(org.apache.hadoop.hbase.ExtendedCellScanner)"><code>HBaseRpcController.setDone(ExtendedCellScanner)</code></a>.</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="#setDone(org.apache.hadoop.hbase.ExtendedCellScanner)" class="member-name-link">setDone</a><wbr>(<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a> cellScanner)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block"><b>IMPORTANT:</b> always call this method if the call finished without any exception to tell |
| the <code>HBaseRpcController</code> that we are done.</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="#setFailed(java.io.IOException)" class="member-name-link">setFailed</a><wbr>(<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> e)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set failed with an exception to pass on.</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="#setFailed(java.lang.String)" class="member-name-link">setFailed</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> reason)</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="#setPriority(int)" class="member-name-link">setPriority</a><wbr>(int priority)</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 priority for this operation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setPriority(org.apache.hadoop.hbase.TableName)" class="member-name-link">setPriority</a><wbr>(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Set the priority for this operation.</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="#setRequestAttributes(java.util.Map)" class="member-name-link">setRequestAttributes</a><wbr>(<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>byte[]> requestAttributes)</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 map of request attributes</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="#setTableName(org.apache.hadoop.hbase.TableName)" class="member-name-link">setTableName</a><wbr>(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Sets Region's table name.</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="#startCancel()" class="member-name-link">startCancel</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="callTimeout"> |
| <h3>callTimeout</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-44">callTimeout</a></span></div> |
| <div class="block">The time, in ms before the call should expire.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="done"> |
| <h3>done</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/HBaseRpcControllerImpl.html#line-46">done</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cancelled"> |
| <h3>cancelled</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/HBaseRpcControllerImpl.html#line-48">cancelled</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cancellationCbs"> |
| <h3>cancellationCbs</h3> |
| <div class="member-signature"><span class="modifiers">private 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><org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<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>>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-50">cancellationCbs</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="exception"> |
| <h3>exception</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><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> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-52">exception</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="tableName"> |
| <h3>tableName</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-54">tableName</a></span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="regionInfo"> |
| <h3>regionInfo</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-60">regionInfo</a></span></div> |
| <div class="block">Rpc target Region's RegionInfo we are going against. May be null.</div> |
| <dl class="notes"> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="#hasRegionInfo()"><code>hasRegionInfo()</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="priority"> |
| <h3>priority</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-67">priority</a></span></div> |
| <div class="block">Priority to set on this request. Set it here in controller so available composing the request. |
| This is the ordained way of setting priorities going forward. We will be undoing the old |
| annotation-based mechanism.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cellScanner"> |
| <h3>cellScanner</h3> |
| <div class="member-signature"><span class="modifiers">private</span> <span class="return-type"><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/HBaseRpcControllerImpl.html#line-75">cellScanner</a></span></div> |
| <div class="block">They are optionally set on construction, cleared after we make the call, and then optionally |
| set on response with the result. We use this lowest common denominator access to Cells because |
| sometimes the scanner is backed by a List of Cells and other times, it is backed by an encoded |
| block that implements CellScanner.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="requestAttributes"> |
| <h3>requestAttributes</h3> |
| <div class="member-signature"><span class="modifiers">private</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>byte[]></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-77">requestAttributes</a></span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>HBaseRpcControllerImpl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-79">HBaseRpcControllerImpl</a></span>()</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.ExtendedCellScanner)"> |
| <h3>HBaseRpcControllerImpl</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-86">HBaseRpcControllerImpl</a></span><wbr><span class="parameters">(<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a> cellScanner)</span></div> |
| <div class="block">Used server-side. Clients should go via <a href="RpcControllerFactory.html" title="class in org.apache.hadoop.hbase.ipc"><code>RpcControllerFactory</code></a></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.client.RegionInfo,org.apache.hadoop.hbase.ExtendedCellScanner)"> |
| <h3>HBaseRpcControllerImpl</h3> |
| <div class="member-signature"><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-90">HBaseRpcControllerImpl</a></span><wbr><span class="parameters">(<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| <a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a> cellScanner)</span></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="<init>(org.apache.hadoop.hbase.client.RegionInfo,java.util.List)"> |
| <h3>HBaseRpcControllerImpl</h3> |
| <div class="member-signature"><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-95">HBaseRpcControllerImpl</a></span><wbr><span class="parameters">(<a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> regionInfo, |
| <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="../ExtendedCellScannable.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScannable</a>> cellIterables)</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="hasRegionInfo()"> |
| <h3>hasRegionInfo</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/HBaseRpcControllerImpl.html#line-101">hasRegionInfo</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#hasRegionInfo()">HBaseRpcController</a></code></span></div> |
| <div class="block">Returns True if this Controller is carrying the RPC target Region's RegionInfo.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#hasRegionInfo()">hasRegionInfo</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRegionInfo()"> |
| <h3>getRegionInfo</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-106">getRegionInfo</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#getRegionInfo()">HBaseRpcController</a></code></span></div> |
| <div class="block">Returns Target Region's RegionInfo or null if not available or pertinent.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#getRegionInfo()">getRegionInfo</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cellScanner()"> |
| <h3>cellScanner</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><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/HBaseRpcControllerImpl.html#line-112">cellScanner</a></span>()</div> |
| <div class="block">Returns One-shot cell scanner (you cannot back it up and restart)</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../CellScannable.html#cellScanner()">cellScanner</a></code> in interface <code><a href="../CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ExtendedCellScannable.html#cellScanner()">cellScanner</a></code> in interface <code><a href="../ExtendedCellScannable.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScannable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCellScanner(org.apache.hadoop.hbase.ExtendedCellScanner)"> |
| <h3>setCellScanner</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/HBaseRpcControllerImpl.html#line-117">setCellScanner</a></span><wbr><span class="parameters">(<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a> cellScanner)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#setCellScanner(org.apache.hadoop.hbase.ExtendedCellScanner)">HBaseRpcController</a></code></span></div> |
| <div class="block">Only used to send cells to rpc server, the returned cells should be set by |
| <a href="HBaseRpcController.html#setDone(org.apache.hadoop.hbase.ExtendedCellScanner)"><code>HBaseRpcController.setDone(ExtendedCellScanner)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#setCellScanner(org.apache.hadoop.hbase.ExtendedCellScanner)">setCellScanner</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPriority(int)"> |
| <h3>setPriority</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/HBaseRpcControllerImpl.html#line-124">setPriority</a></span><wbr><span class="parameters">(int priority)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#setPriority(int)">HBaseRpcController</a></code></span></div> |
| <div class="block">Set the priority for this operation.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#setPriority(int)">setPriority</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>priority</code> - Priority for this request; should fall roughly in the range |
| <a href="../HConstants.html#NORMAL_QOS"><code>HConstants.NORMAL_QOS</code></a> to <a href="../HConstants.html#HIGH_QOS"><code>HConstants.HIGH_QOS</code></a></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setPriority(org.apache.hadoop.hbase.TableName)"> |
| <h3>setPriority</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/HBaseRpcControllerImpl.html#line-130">setPriority</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#setPriority(org.apache.hadoop.hbase.TableName)">HBaseRpcController</a></code></span></div> |
| <div class="block">Set the priority for this operation.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#setPriority(org.apache.hadoop.hbase.TableName)">setPriority</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>tn</code> - Set priority based off the table we are going against.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getPriority()"> |
| <h3>getPriority</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-136">getPriority</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#getPriority()">HBaseRpcController</a></code></span></div> |
| <div class="block">Returns The priority of this request</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#getPriority()">getPriority</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reset()"> |
| <h3>reset</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/HBaseRpcControllerImpl.html#line-141">reset</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>reset</code> in interface <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getCallTimeout()"> |
| <h3>getCallTimeout</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-162">getCallTimeout</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#getCallTimeout()">getCallTimeout</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setCallTimeout(int)"> |
| <h3>setCallTimeout</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/HBaseRpcControllerImpl.html#line-167">setCallTimeout</a></span><wbr><span class="parameters">(int callTimeout)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#setCallTimeout(int)">setCallTimeout</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="hasCallTimeout()"> |
| <h3>hasCallTimeout</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/HBaseRpcControllerImpl.html#line-172">hasCallTimeout</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#hasCallTimeout()">hasCallTimeout</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getRequestAttributes()"> |
| <h3>getRequestAttributes</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/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>byte[]></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-177">getRequestAttributes</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#getRequestAttributes()">HBaseRpcController</a></code></span></div> |
| <div class="block">Get the map of request attributes</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#getRequestAttributes()">getRequestAttributes</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setRequestAttributes(java.util.Map)"> |
| <h3>setRequestAttributes</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/HBaseRpcControllerImpl.html#line-182">setRequestAttributes</a></span><wbr><span class="parameters">(<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>byte[]> requestAttributes)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#setRequestAttributes(java.util.Map)">HBaseRpcController</a></code></span></div> |
| <div class="block">Set the map of request attributes</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#setRequestAttributes(java.util.Map)">setRequestAttributes</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="errorText()"> |
| <h3>errorText</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-187">errorText</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>errorText</code> in interface <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="failed()"> |
| <h3>failed</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/HBaseRpcControllerImpl.html#line-195">failed</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>failed</code> in interface <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isCanceled()"> |
| <h3>isCanceled</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/HBaseRpcControllerImpl.html#line-200">isCanceled</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>isCanceled</code> in interface <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback)"> |
| <h3>notifyOnCancel</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/HBaseRpcControllerImpl.html#line-205">notifyOnCancel</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<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>> callback)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback)">HBaseRpcController</a></code></span></div> |
| <div class="block">A little different from the basic RpcController: |
| <ol> |
| <li>You can register multiple callbacks to an <code>HBaseRpcController</code>.</li> |
| <li>The callback will not be called if the rpc call is finished without any cancellation.</li> |
| <li>You can call me at client side also.</li> |
| </ol></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback)">notifyOnCancel</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code>notifyOnCancel</code> in interface <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFailed(java.lang.String)"> |
| <h3>setFailed</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/HBaseRpcControllerImpl.html#line-220">setFailed</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> reason)</span></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>setFailed</code> in interface <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setFailed(java.io.IOException)"> |
| <h3>setFailed</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/HBaseRpcControllerImpl.html#line-229">setFailed</a></span><wbr><span class="parameters">(<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> e)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#setFailed(java.io.IOException)">HBaseRpcController</a></code></span></div> |
| <div class="block">Set failed with an exception to pass on. For use in async rpc clients</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#setFailed(java.io.IOException)">setFailed</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>e</code> - exception to set with</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getFailed()"> |
| <h3>getFailed</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/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-238">getFailed</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#getFailed()">HBaseRpcController</a></code></span></div> |
| <div class="block">Return the failed exception, null if not failed.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#getFailed()">getFailed</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDone(org.apache.hadoop.hbase.ExtendedCellScanner)"> |
| <h3>setDone</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/HBaseRpcControllerImpl.html#line-243">setDone</a></span><wbr><span class="parameters">(<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a> cellScanner)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#setDone(org.apache.hadoop.hbase.ExtendedCellScanner)">HBaseRpcController</a></code></span></div> |
| <div class="block"><b>IMPORTANT:</b> always call this method if the call finished without any exception to tell |
| the <code>HBaseRpcController</code> that we are done.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#setDone(org.apache.hadoop.hbase.ExtendedCellScanner)">setDone</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="startCancel()"> |
| <h3>startCancel</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/HBaseRpcControllerImpl.html#line-252">startCancel</a></span>()</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code>startCancel</code> in interface <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback,org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)"> |
| <h3>notifyOnCancel</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/HBaseRpcControllerImpl.html#line-270">notifyOnCancel</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<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>> callback, |
| <a href="HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a> action)</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"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback,org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)">HBaseRpcController</a></code></span></div> |
| <div class="block">If not cancelled, add the callback to cancellation callback list. And then execute the action |
| with the cancellation state as a parameter. The implementation should guarantee that the |
| cancellation state does not change during this call.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback,org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)">notifyOnCancel</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</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="setTableName(org.apache.hadoop.hbase.TableName)"> |
| <h3>setTableName</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/HBaseRpcControllerImpl.html#line-281">setTableName</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tableName)</span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#setTableName(org.apache.hadoop.hbase.TableName)">HBaseRpcController</a></code></span></div> |
| <div class="block">Sets Region's table name.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#setTableName(org.apache.hadoop.hbase.TableName)">setTableName</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getTableName()"> |
| <h3>getTableName</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line-286">getTableName</a></span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="HBaseRpcController.html#getTableName()">HBaseRpcController</a></code></span></div> |
| <div class="block">Returns Region's table name or null if not available or pertinent.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="HBaseRpcController.html#getTableName()">getTableName</a></code> in interface <code><a href="HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
