blob: 5ad7b48336ee6986c8499a681488b73c15296ba6 [file] [log] [blame]
<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>HBaseRpcController (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: HBaseRpcController">
<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/HBaseRpcController.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html#class">Help</a></li>
</ul>
</div>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li><a href="#nested-class-summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method-detail">Method</a></li>
</ul>
</div>
<div class="nav-list-search"><label for="search-input">SEARCH:</label>
<input type="text" id="search-input" value="search" disabled="disabled">
<input type="reset" id="reset-button" value="reset" disabled="disabled">
</div>
</div>
<!-- ========= END OF TOP NAVBAR ========= -->
<span class="skip-nav" id="skip-navbar-top"></span></nav>
</header>
<div class="flex-content">
<main role="main">
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.hadoop.hbase.ipc</a></div>
<h1 title="Interface HBaseRpcController" class="title">Interface HBaseRpcController</h1>
</div>
<section class="class-description" id="class-description">
<dl class="notes">
<dt>All Superinterfaces:</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>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd>
</dl>
<dl class="notes">
<dt>All Known Implementing Classes:</dt>
<dd><code><a href="DelegatingHBaseRpcController.html" title="class in org.apache.hadoop.hbase.ipc">DelegatingHBaseRpcController</a></code>, <code><a href="HBaseRpcControllerImpl.html" title="class in org.apache.hadoop.hbase.ipc">HBaseRpcControllerImpl</a></code></dd>
</dl>
<hr>
<div class="type-signature"><span class="annotations">@LimitedPrivate({"Coprocesssor","Phoenix","Replication"})
@Evolving
</span><span class="modifiers">public interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-42">HBaseRpcController</a></span><span class="extends-implements">
extends org.apache.hbase.thirdparty.com.google.protobuf.RpcController, <a href="../ExtendedCellScannable.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScannable</a></span></div>
<div class="block">Optionally carries Cells across the proxy/service interface down into ipc. On its way out it
optionally carries a set of result Cell data. We stick the Cells here when we want to avoid
having to protobuf them (for performance reasons). This class is used ferrying data across the
proxy/protobuf service chasm. Also does call timeout and on client-side, carries the target
RegionInfo we're making the call against if relevant (useful adding info to exceptions and logs).
Used by client and server ipc'ing.</div>
</section>
<section class="summary">
<ul class="summary-list">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<li>
<section class="nested-class-summary" id="nested-class-summary">
<h2>Nested Class Summary</h2>
<div class="caption"><span>Nested Classes</span></div>
<div class="summary-table three-column-summary">
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Interface</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>static interface&nbsp;</code></div>
<div class="col-second even-row-color"><code><a href="HBaseRpcController.CancellationCallback.html" class="type-name-link" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a></code></div>
<div class="col-last even-row-color">&nbsp;</div>
</div>
</section>
</li>
<!-- ========== METHOD SUMMARY =========== -->
<li>
<section class="method-summary" id="method-summary">
<h2>Method Summary</h2>
<div id="method-summary-table">
<div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default 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>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getCallTimeout()" class="member-name-link">getCallTimeout</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getFailed()" class="member-name-link">getFailed</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Return the failed exception, null if not failed.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>int</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getPriority()" class="member-name-link">getPriority</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Returns The priority of this request</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getRegionInfo()" class="member-name-link">getRegionInfo</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Returns Target Region's RegionInfo or null if not available or pertinent.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><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>&lt;<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[]&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getRequestAttributes()" class="member-name-link">getRequestAttributes</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Get the map of request attributes</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default <a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#getTableName()" class="member-name-link">getTableName</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Returns Region's table name or null if not available or pertinent.</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="#hasCallTimeout()" class="member-name-link">hasCallTimeout</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#hasRegionInfo()" class="member-name-link">hasRegionInfo</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Returns True if this Controller is carrying the RPC target Region's RegionInfo.</div>
</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="#notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback)" class="member-name-link">notifyOnCancel</a><wbr>(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback&lt;<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>&gt;&nbsp;callback)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<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-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="#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&lt;<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>&gt;&nbsp;callback,
<a href="HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a>&nbsp;action)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<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-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="#setCallTimeout(int)" class="member-name-link">setCallTimeout</a><wbr>(int&nbsp;callTimeout)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</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="#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>&nbsp;cellScanner)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Only used to send cells to rpc server, the returned cells should be set by
<a href="#setDone(org.apache.hadoop.hbase.ExtendedCellScanner)"><code>setDone(ExtendedCellScanner)</code></a>.</div>
</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="#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>&nbsp;cellScanner)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<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 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="#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>&nbsp;e)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Set failed with an exception to pass on.</div>
</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="#setPriority(int)" class="member-name-link">setPriority</a><wbr>(int&nbsp;priority)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<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-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="#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>&nbsp;tn)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<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-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="#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>&lt;<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[]&gt;&nbsp;requestAttributes)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<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-tab5"><code>default void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><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>&nbsp;tableName)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5">
<div class="block">Sets Region's table name.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hadoop.hbase.ExtendedCellScannable">Methods inherited from interface&nbsp;org.apache.hadoop.hbase.<a href="../ExtendedCellScannable.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScannable</a></h3>
<code><a href="../ExtendedCellScannable.html#cellScanner()">cellScanner</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.apache.hbase.thirdparty.com.google.protobuf.RpcController">Methods inherited from interface&nbsp;org.apache.hbase.thirdparty.com.google.protobuf.RpcController</h3>
<code>errorText, failed, isCanceled, reset, setFailed, startCancel</code></div>
</section>
</li>
</ul>
</section>
<section class="details">
<ul class="details-list">
<!-- ============ METHOD DETAIL ========== -->
<li>
<section class="method-details" id="method-detail">
<h2>Method Details</h2>
<ul class="member-list">
<li>
<section class="detail" id="setCellScanner(org.apache.hadoop.hbase.ExtendedCellScanner)">
<h3>setCellScanner</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-51">setCellScanner</a></span><wbr><span class="parameters">(<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner)</span></div>
<div class="block">Only used to send cells to rpc server, the returned cells should be set by
<a href="#setDone(org.apache.hadoop.hbase.ExtendedCellScanner)"><code>setDone(ExtendedCellScanner)</code></a>.</div>
</section>
</li>
<li>
<section class="detail" id="setPriority(int)">
<h3>setPriority</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-58">setPriority</a></span><wbr><span class="parameters">(int&nbsp;priority)</span></div>
<div class="block">Set the priority for this operation.</div>
<dl class="notes">
<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="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-64">setPriority</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tn)</span></div>
<div class="block">Set the priority for this operation.</div>
<dl class="notes">
<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="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-67">getPriority</a></span>()</div>
<div class="block">Returns The priority of this request</div>
</section>
</li>
<li>
<section class="detail" id="getCallTimeout()">
<h3>getCallTimeout</h3>
<div class="member-signature"><span class="return-type">int</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-69">getCallTimeout</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="setCallTimeout(int)">
<h3>setCallTimeout</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-71">setCallTimeout</a></span><wbr><span class="parameters">(int&nbsp;callTimeout)</span></div>
</section>
</li>
<li>
<section class="detail" id="hasCallTimeout()">
<h3>hasCallTimeout</h3>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-73">hasCallTimeout</a></span>()</div>
</section>
</li>
<li>
<section class="detail" id="getRequestAttributes()">
<h3>getRequestAttributes</h3>
<div class="member-signature"><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>&lt;<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[]&gt;</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-78">getRequestAttributes</a></span>()</div>
<div class="block">Get the map of request attributes</div>
</section>
</li>
<li>
<section class="detail" id="setRequestAttributes(java.util.Map)">
<h3>setRequestAttributes</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-83">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>&lt;<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[]&gt;&nbsp;requestAttributes)</span></div>
<div class="block">Set the map of request attributes</div>
</section>
</li>
<li>
<section class="detail" id="setFailed(java.io.IOException)">
<h3>setFailed</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-89">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>&nbsp;e)</span></div>
<div class="block">Set failed with an exception to pass on. For use in async rpc clients</div>
<dl class="notes">
<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="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>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-94">getFailed</a></span>()</div>
<div class="block">Return the failed exception, null if not failed.</div>
</section>
</li>
<li>
<section class="detail" id="setDone(org.apache.hadoop.hbase.ExtendedCellScanner)">
<h3>setDone</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-100">setDone</a></span><wbr><span class="parameters">(<a href="../ExtendedCellScanner.html" title="interface in org.apache.hadoop.hbase">ExtendedCellScanner</a>&nbsp;cellScanner)</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>
</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="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-110">notifyOnCancel</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback&lt;<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>&gt;&nbsp;callback)</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>notifyOnCancel</code>&nbsp;in interface&nbsp;<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="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-122">notifyOnCancel</a></span><wbr><span class="parameters">(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback&lt;<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>&gt;&nbsp;callback,
<a href="HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a>&nbsp;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">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>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="hasRegionInfo()">
<h3>hasRegionInfo</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">boolean</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-125">hasRegionInfo</a></span>()</div>
<div class="block">Returns True if this Controller is carrying the RPC target Region's RegionInfo.</div>
</section>
</li>
<li>
<section class="detail" id="getRegionInfo()">
<h3>getRegionInfo</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="../client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-130">getRegionInfo</a></span>()</div>
<div class="block">Returns Target Region's RegionInfo or null if not available or pertinent.</div>
</section>
</li>
<li>
<section class="detail" id="setTableName(org.apache.hadoop.hbase.TableName)">
<h3>setTableName</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-135">setTableName</a></span><wbr><span class="parameters">(<a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a>&nbsp;tableName)</span></div>
<div class="block">Sets Region's table name.</div>
</section>
</li>
<li>
<section class="detail" id="getTableName()">
<h3>getTableName</h3>
<div class="member-signature"><span class="modifiers">default</span>&nbsp;<span class="return-type"><a href="../TableName.html" title="class in org.apache.hadoop.hbase">TableName</a></span>&nbsp;<span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line-140">getTableName</a></span>()</div>
<div class="block">Returns Region's table name or null if not available or pertinent.</div>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
<footer role="contentinfo">
<hr>
<p class="legal-copy"><small>Copyright &#169; 2007&#x2013;2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</footer>
</div>
</div>
</body>
</html>