| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>HBaseRpcController (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="HBaseRpcController (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":18,"i4":6,"i5":18,"i6":6,"i7":6,"i8":6,"i9":6,"i10":6,"i11":6,"i12":6,"i13":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/ipc/FifoRpcScheduler.FifoCallRunner.html" title="class in org.apache.hadoop.hbase.ipc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/ipc/HBaseRpcController.html" target="_top">Frames</a></li> |
| <li><a href="HBaseRpcController.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.hadoop.hbase.ipc</div> |
| <h2 title="Interface HBaseRpcController" class="title">Interface HBaseRpcController</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a>, org.apache.hbase.thirdparty.com.google.protobuf.RpcController</dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/ipc/DelegatingHBaseRpcController.html" title="class in org.apache.hadoop.hbase.ipc">DelegatingHBaseRpcController</a>, <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html" title="class in org.apache.hadoop.hbase.ipc">HBaseRpcControllerImpl</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@InterfaceAudience.LimitedPrivate(value={"Coprocesssor","Phoenix","Replication"}) |
| @InterfaceStability.Evolving |
| public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.45">HBaseRpcController</a> |
| extends org.apache.hbase.thirdparty.com.google.protobuf.RpcController, <a href="../../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a></pre> |
| <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> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static interface </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getCallTimeout--">getCallTimeout</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getFailed--">getFailed</a></span>()</code> |
| <div class="block">Return the failed exception, null if not failed.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getPriority--">getPriority</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>default <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getRegionInfo--">getRegionInfo</a></span>()</code> </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#hasCallTimeout--">hasCallTimeout</a></span>()</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#hasRegionInfo--">hasRegionInfo</a></span>()</code> </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#notifyOnCancel-org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback-">notifyOnCancel</a></span>(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> callback)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#notifyOnCancel-org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback-org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback-">notifyOnCancel</a></span>(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> callback, |
| <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a> action)</code> |
| <div class="block">If not cancelled, add the callback to cancellation callback list.</div> |
| </td> |
| </tr> |
| <tr id="i8" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setCallTimeout-int-">setCallTimeout</a></span>(int callTimeout)</code> </td> |
| </tr> |
| <tr id="i9" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setCellScanner-org.apache.hadoop.hbase.CellScanner-">setCellScanner</a></span>(<a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> cellScanner)</code> |
| <div class="block">Only used to send cells to rpc server, the returned cells should be set by |
| <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setDone-org.apache.hadoop.hbase.CellScanner-"><code>setDone(CellScanner)</code></a>.</div> |
| </td> |
| </tr> |
| <tr id="i10" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setDone-org.apache.hadoop.hbase.CellScanner-">setDone</a></span>(<a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> cellScanner)</code> |
| <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> |
| </td> |
| </tr> |
| <tr id="i11" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setFailed-java.io.IOException-">setFailed</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a> e)</code> |
| <div class="block">Set failed with an exception to pass on.</div> |
| </td> |
| </tr> |
| <tr id="i12" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setPriority-int-">setPriority</a></span>(int priority)</code> </td> |
| </tr> |
| <tr id="i13" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setPriority-org.apache.hadoop.hbase.TableName-">setPriority</a></span>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hbase.thirdparty.com.google.protobuf.RpcController"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hbase.thirdparty.com.google.protobuf.RpcController</h3> |
| <code>errorText, failed, isCanceled, reset, setFailed, startCancel</code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.hbase.CellScannable"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from interface org.apache.hadoop.hbase.<a href="../../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a></h3> |
| <code><a href="../../../../../org/apache/hadoop/hbase/CellScannable.html#cellScanner--">cellScanner</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setCellScanner-org.apache.hadoop.hbase.CellScanner-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCellScanner</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.51">setCellScanner</a>(<a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> cellScanner)</pre> |
| <div class="block">Only used to send cells to rpc server, the returned cells should be set by |
| <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setDone-org.apache.hadoop.hbase.CellScanner-"><code>setDone(CellScanner)</code></a>.</div> |
| </li> |
| </ul> |
| <a name="setPriority-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPriority</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.57">setPriority</a>(int priority)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>priority</code> - Priority for this request; should fall roughly in the range |
| <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#NORMAL_QOS"><code>HConstants.NORMAL_QOS</code></a> to <a href="../../../../../org/apache/hadoop/hbase/HConstants.html#HIGH_QOS"><code>HConstants.HIGH_QOS</code></a></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="setPriority-org.apache.hadoop.hbase.TableName-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPriority</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.62">setPriority</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</pre> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>tn</code> - Set priority based off the table we are going against.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getPriority--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPriority</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.67">getPriority</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The priority of this request</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getCallTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCallTimeout</h4> |
| <pre>int <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.69">getCallTimeout</a>()</pre> |
| </li> |
| </ul> |
| <a name="setCallTimeout-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCallTimeout</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.71">setCallTimeout</a>(int callTimeout)</pre> |
| </li> |
| </ul> |
| <a name="hasCallTimeout--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasCallTimeout</h4> |
| <pre>boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.73">hasCallTimeout</a>()</pre> |
| </li> |
| </ul> |
| <a name="setFailed-java.io.IOException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setFailed</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.79">setFailed</a>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a> e)</pre> |
| <div class="block">Set failed with an exception to pass on. For use in async rpc clients</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>e</code> - exception to set with</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getFailed--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getFailed</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.84">getFailed</a>()</pre> |
| <div class="block">Return the failed exception, null if not failed.</div> |
| </li> |
| </ul> |
| <a name="setDone-org.apache.hadoop.hbase.CellScanner-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDone</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.90">setDone</a>(<a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> cellScanner)</pre> |
| <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> |
| </li> |
| </ul> |
| <a name="notifyOnCancel-org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notifyOnCancel</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.101">notifyOnCancel</a>(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> callback)</pre> |
| <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> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>notifyOnCancel</code> in interface <code>org.apache.hbase.thirdparty.com.google.protobuf.RpcController</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="notifyOnCancel-org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback-org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>notifyOnCancel</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.112">notifyOnCancel</a>(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> callback, |
| <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a> action) |
| throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <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> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="hasRegionInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasRegionInfo</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.117">hasRegionInfo</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>True if this Controller is carrying the RPC target Region's RegionInfo.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getRegionInfo--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getRegionInfo</h4> |
| <pre>default <a href="../../../../../org/apache/hadoop/hbase/client/RegionInfo.html" title="interface in org.apache.hadoop.hbase.client">RegionInfo</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.124">getRegionInfo</a>()</pre> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Target Region's RegionInfo or null if not available or pertinent.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/hadoop/hbase/ipc/FifoRpcScheduler.FifoCallRunner.html" title="class in org.apache.hadoop.hbase.ipc"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/ipc/HBaseRpcController.html" target="_top">Frames</a></li> |
| <li><a href="HBaseRpcController.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2007–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
