http://git-wip-us.apache.org/repos/asf/hbase-site/blob/8ba76a42/devapidocs/org/apache/hadoop/hbase/ipc/HBaseRpcController.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/ipc/HBaseRpcController.html b/devapidocs/org/apache/hadoop/hbase/ipc/HBaseRpcController.html new file mode 100644 index 0000000..4e4baf8 --- /dev/null +++ b/devapidocs/org/apache/hadoop/hbase/ipc/HBaseRpcController.html @@ -0,0 +1,481 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>HBaseRpcController (Apache HBase 2.0.0-SNAPSHOT API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="HBaseRpcController (Apache HBase 2.0.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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.html" title="class in org.apache.hadoop.hbase.ipc"><span class="strong">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="strong">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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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>, 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><a href="../../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> +public interface <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.38">HBaseRpcController</a> +extends 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. 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="overviewSummary" 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><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a></strong></code> </td> +</tr> +</table> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#PRIORITY_UNSET">PRIORITY_UNSET</a></strong></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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getCallTimeout()">getCallTimeout</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getFailed()">getFailed</a></strong>()</code> +<div class="block">Return the failed exception, null if not failed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getPriority()">getPriority</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#hasCallTimeout()">hasCallTimeout</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#notifyOnCancel(com.google.protobuf.RpcCallback)">notifyOnCancel</a></strong>(com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/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 class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#notifyOnCancel(com.google.protobuf.RpcCallback,%20org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)">notifyOnCancel</a></strong>(com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/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 class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setCallTimeout(int)">setCallTimeout</a></strong>(int callTimeout)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setCellScanner(org.apache.hadoop.hbase.CellScanner)">setCellScanner</a></strong>(<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 class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setDone(org.apache.hadoop.hbase.CellScanner)">setDone</a></strong>(<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 class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setFailed(java.io.IOException)">setFailed</a></strong>(<a href="http://docs.oracle.com/javase/7/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 class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setPriority(int)">setPriority</a></strong>(int priority)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setPriority(org.apache.hadoop.hbase.TableName)">setPriority</a></strong>(<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_com.google.protobuf.RpcController"> +<!-- --> +</a> +<h3>Methods inherited from interface 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"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="PRIORITY_UNSET"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PRIORITY_UNSET</h4> +<pre>static final int <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.40">PRIORITY_UNSET</a></pre> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../constant-values.html#org.apache.hadoop.hbase.ipc.HBaseRpcController.PRIORITY_UNSET">Constant Field Values</a></dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ 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.46">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.52">setPriority</a>(int priority)</pre> +<dl><dt><span class="strong">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.57">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="strong">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.62">getPriority</a>()</pre> +<dl><dt><span class="strong">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.64">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.66">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.68">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.74">setFailed</a>(<a href="http://docs.oracle.com/javase/7/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="strong">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="http://docs.oracle.com/javase/7/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.79">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.85">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(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.96">notifyOnCancel</a>(com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/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><strong>Specified by:</strong></dt> +<dd><code>notifyOnCancel</code> in interface <code>com.google.protobuf.RpcController</code></dd> +</dl> +</li> +</ul> +<a name="notifyOnCancel(com.google.protobuf.RpcCallback, org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>notifyOnCancel</h4> +<pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcController.html#line.107">notifyOnCancel</a>(com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/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="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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.html" title="class in org.apache.hadoop.hbase.ipc"><span class="strong">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="strong">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><a href="#field_summary">Field</a> | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#field_detail">Field</a> | </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–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
http://git-wip-us.apache.org/repos/asf/hbase-site/blob/8ba76a42/devapidocs/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html b/devapidocs/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html new file mode 100644 index 0000000..28624a1 --- /dev/null +++ b/devapidocs/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html @@ -0,0 +1,798 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd";> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>HBaseRpcControllerImpl (Apache HBase 2.0.0-SNAPSHOT API)</title> +<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="HBaseRpcControllerImpl (Apache HBase 2.0.0-SNAPSHOT API)"; + } +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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/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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRPCErrorHandler.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html" target="_top">Frames</a></li> +<li><a href="HBaseRpcControllerImpl.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>Nested | </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="subNavList"> +<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> +<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="Class HBaseRpcControllerImpl" class="title">Class HBaseRpcControllerImpl</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.hadoop.hbase.ipc.HBaseRpcControllerImpl</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>com.google.protobuf.RpcController, <a href="../../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a>, <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></dd> +</dl> +<hr> +<br> +<pre><a href="../../../../../org/apache/hadoop/hbase/classification/InterfaceAudience.Private.html" title="annotation in org.apache.hadoop.hbase.classification">@InterfaceAudience.Private</a> +public class <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.40">HBaseRpcControllerImpl</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> +implements <a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</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. 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> +<ul class="blockList"> +<li class="blockList"><a name="nested_classes_inherited_from_class_org.apache.hadoop.hbase.ipc.HBaseRpcController"> +<!-- --> +</a> +<h3>Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.ipc.<a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></h3> +<code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController.CancellationCallback</a></code></li> +</ul> +</li> +</ul> +<!-- =========== FIELD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#callTimeout">callTimeout</a></strong></code> +<div class="block">The time, in ms before the call should expire.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#cancellationCbs">cancellationCbs</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#cancelled">cancelled</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private <a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#cellScanner">cellScanner</a></strong></code> +<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> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#done">done</a></strong></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>private <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#exception">exception</a></strong></code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>private int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#priority">priority</a></strong></code> +<div class="block">Priority to set on this request.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="fields_inherited_from_class_org.apache.hadoop.hbase.ipc.HBaseRpcController"> +<!-- --> +</a> +<h3>Fields inherited from interface org.apache.hadoop.hbase.ipc.<a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></h3> +<code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#PRIORITY_UNSET">PRIORITY_UNSET</a></code></li> +</ul> +</li> +</ul> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#HBaseRpcControllerImpl()">HBaseRpcControllerImpl</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#HBaseRpcControllerImpl(org.apache.hadoop.hbase.CellScanner)">HBaseRpcControllerImpl</a></strong>(<a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> cellScanner)</code> </td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#HBaseRpcControllerImpl(java.util.List)">HBaseRpcControllerImpl</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a>> cellIterables)</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#cellScanner()">cellScanner</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#errorText()">errorText</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#failed()">failed</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#getCallTimeout()">getCallTimeout</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#getFailed()">getFailed</a></strong>()</code> +<div class="block">Return the failed exception, null if not failed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#getPriority()">getPriority</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#hasCallTimeout()">hasCallTimeout</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#isCanceled()">isCanceled</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#notifyOnCancel(com.google.protobuf.RpcCallback)">notifyOnCancel</a></strong>(com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/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 class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#notifyOnCancel(com.google.protobuf.RpcCallback,%20org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)">notifyOnCancel</a></strong>(com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/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 class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#reset()">reset</a></strong>()</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#setCallTimeout(int)">setCallTimeout</a></strong>(int callTimeout)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#setCellScanner(org.apache.hadoop.hbase.CellScanner)">setCellScanner</a></strong>(<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>HBaseRpcController.setDone(CellScanner)</code></a>.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#setDone(org.apache.hadoop.hbase.CellScanner)">setDone</a></strong>(<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 class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#setFailed(java.io.IOException)">setFailed</a></strong>(<a href="http://docs.oracle.com/javase/7/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 class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#setFailed(java.lang.String)">setFailed</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> reason)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#setPriority(int)">setPriority</a></strong>(int priority)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#setPriority(org.apache.hadoop.hbase.TableName)">setPriority</a></strong>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#startCancel()">startCancel</a></strong>()</code> </td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ FIELD DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="callTimeout"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>callTimeout</h4> +<pre>private <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Integer.html?is-external=true"; title="class or interface in java.lang">Integer</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.44">callTimeout</a></pre> +<div class="block">The time, in ms before the call should expire.</div> +</li> +</ul> +<a name="done"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>done</h4> +<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.46">done</a></pre> +</li> +</ul> +<a name="cancelled"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancelled</h4> +<pre>private boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.48">cancelled</a></pre> +</li> +</ul> +<a name="cancellationCbs"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cancellationCbs</h4> +<pre>private final <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>>> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.50">cancellationCbs</a></pre> +</li> +</ul> +<a name="exception"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>exception</h4> +<pre>private <a href="http://docs.oracle.com/javase/7/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/HBaseRpcControllerImpl.html#line.52">exception</a></pre> +</li> +</ul> +<a name="priority"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>priority</h4> +<pre>private int <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.59">priority</a></pre> +<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> +</li> +</ul> +<a name="cellScanner"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>cellScanner</h4> +<pre>private <a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.67">cellScanner</a></pre> +<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> +</li> +</ul> +</li> +</ul> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="HBaseRpcControllerImpl()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HBaseRpcControllerImpl</h4> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.69">HBaseRpcControllerImpl</a>()</pre> +</li> +</ul> +<a name="HBaseRpcControllerImpl(org.apache.hadoop.hbase.CellScanner)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>HBaseRpcControllerImpl</h4> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.73">HBaseRpcControllerImpl</a>(<a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> cellScanner)</pre> +</li> +</ul> +<a name="HBaseRpcControllerImpl(java.util.List)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>HBaseRpcControllerImpl</h4> +<pre>public <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.77">HBaseRpcControllerImpl</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a>> cellIterables)</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="cellScanner()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cellScanner</h4> +<pre>public <a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.85">cellScanner</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/CellScannable.html#cellScanner()">cellScanner</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/CellScannable.html" title="interface in org.apache.hadoop.hbase">CellScannable</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>One-shot cell scanner (you cannot back it up and restart)</dd></dl> +</li> +</ul> +<a name="setCellScanner(org.apache.hadoop.hbase.CellScanner)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCellScanner</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.92">setCellScanner</a>(<a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> cellScanner)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setCellScanner(org.apache.hadoop.hbase.CellScanner)">HBaseRpcController</a></code></strong></div> +<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>HBaseRpcController.setDone(CellScanner)</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setCellScanner(org.apache.hadoop.hbase.CellScanner)">setCellScanner</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +</dl> +</li> +</ul> +<a name="setPriority(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPriority</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.97">setPriority</a>(int priority)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setPriority(int)">setPriority</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +<dt><span class="strong">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>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.102">setPriority</a>(<a href="../../../../../org/apache/hadoop/hbase/TableName.html" title="class in org.apache.hadoop.hbase">TableName</a> tn)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setPriority(org.apache.hadoop.hbase.TableName)">setPriority</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +<dt><span class="strong">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>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.108">getPriority</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getPriority()">getPriority</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>The priority of this request</dd></dl> +</li> +</ul> +<a name="reset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>reset</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.115">reset</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>reset</code> in interface <code>com.google.protobuf.RpcController</code></dd> +</dl> +</li> +</ul> +<a name="getCallTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCallTimeout</h4> +<pre>public int <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.132">getCallTimeout</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getCallTimeout()">getCallTimeout</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +</dl> +</li> +</ul> +<a name="setCallTimeout(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCallTimeout</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.141">setCallTimeout</a>(int callTimeout)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setCallTimeout(int)">setCallTimeout</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +</dl> +</li> +</ul> +<a name="hasCallTimeout()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hasCallTimeout</h4> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.146">hasCallTimeout</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#hasCallTimeout()">hasCallTimeout</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +</dl> +</li> +</ul> +<a name="errorText()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>errorText</h4> +<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.151">errorText</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>errorText</code> in interface <code>com.google.protobuf.RpcController</code></dd> +</dl> +</li> +</ul> +<a name="failed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>failed</h4> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.159">failed</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>failed</code> in interface <code>com.google.protobuf.RpcController</code></dd> +</dl> +</li> +</ul> +<a name="isCanceled()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isCanceled</h4> +<pre>public boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.164">isCanceled</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>isCanceled</code> in interface <code>com.google.protobuf.RpcController</code></dd> +</dl> +</li> +</ul> +<a name="notifyOnCancel(com.google.protobuf.RpcCallback)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>notifyOnCancel</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.169">notifyOnCancel</a>(com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a>> callback)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#notifyOnCancel(com.google.protobuf.RpcCallback)">HBaseRpcController</a></code></strong></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> +<dt><strong>Specified by:</strong></dt> +<dd><code>notifyOnCancel</code> in interface <code>com.google.protobuf.RpcController</code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#notifyOnCancel(com.google.protobuf.RpcCallback)">notifyOnCancel</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +</dl> +</li> +</ul> +<a name="setFailed(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFailed</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.184">setFailed</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> reason)</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>setFailed</code> in interface <code>com.google.protobuf.RpcController</code></dd> +</dl> +</li> +</ul> +<a name="setFailed(java.io.IOException)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFailed</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.193">setFailed</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a> e)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setFailed(java.io.IOException)">HBaseRpcController</a></code></strong></div> +<div class="block">Set failed with an exception to pass on. For use in async rpc clients</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setFailed(java.io.IOException)">setFailed</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +<dt><span class="strong">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>public <a href="http://docs.oracle.com/javase/7/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/HBaseRpcControllerImpl.html#line.202">getFailed</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getFailed()">HBaseRpcController</a></code></strong></div> +<div class="block">Return the failed exception, null if not failed.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#getFailed()">getFailed</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +</dl> +</li> +</ul> +<a name="setDone(org.apache.hadoop.hbase.CellScanner)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDone</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.207">setDone</a>(<a href="../../../../../org/apache/hadoop/hbase/CellScanner.html" title="interface in org.apache.hadoop.hbase">CellScanner</a> cellScanner)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setDone(org.apache.hadoop.hbase.CellScanner)">HBaseRpcController</a></code></strong></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> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#setDone(org.apache.hadoop.hbase.CellScanner)">setDone</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +</dl> +</li> +</ul> +<a name="startCancel()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startCancel</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.216">startCancel</a>()</pre> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code>startCancel</code> in interface <code>com.google.protobuf.RpcController</code></dd> +</dl> +</li> +</ul> +<a name="notifyOnCancel(com.google.protobuf.RpcCallback, org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>notifyOnCancel</h4> +<pre>public void <a href="../../../../../src-html/org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html#line.234">notifyOnCancel</a>(com.google.protobuf.RpcCallback<<a href="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#notifyOnCancel(com.google.protobuf.RpcCallback,%20org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)">HBaseRpcController</a></code></strong></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> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html#notifyOnCancel(com.google.protobuf.RpcCallback,%20org.apache.hadoop.hbase.ipc.HBaseRpcController.CancellationCallback)">notifyOnCancel</a></code> in interface <code><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.html" title="interface in org.apache.hadoop.hbase.ipc">HBaseRpcController</a></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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/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">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRpcController.CancellationCallback.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/ipc/HBaseRPCErrorHandler.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/hadoop/hbase/ipc/HBaseRpcControllerImpl.html" target="_top">Frames</a></li> +<li><a href="HBaseRpcControllerImpl.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>Nested | </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="subNavList"> +<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> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2007–2016 <a href="http://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/hbase-site/blob/8ba76a42/devapidocs/org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapperImpl.html ---------------------------------------------------------------------- diff --git a/devapidocs/org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapperImpl.html b/devapidocs/org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapperImpl.html index 821f029..3b41268 100644 --- a/devapidocs/org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapperImpl.html +++ b/devapidocs/org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapperImpl.html @@ -36,7 +36,7 @@ <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapper.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/hadoop/hbase/ipc/PayloadCarryingRpcController.html" title="class in org.apache.hadoop.hbase.ipc"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/ipc/PriorityFunction.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapperImpl.html" target="_top">Frames</a></li> @@ -388,7 +388,7 @@ implements <a href="../../../../../org/apache/hadoop/hbase/ipc/MetricsHBaseServe <div class="subNav"> <ul class="navList"> <li><a href="../../../../../org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapper.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="strong">Prev Class</span></a></li> -<li><a href="../../../../../org/apache/hadoop/hbase/ipc/PayloadCarryingRpcController.html" title="class in org.apache.hadoop.hbase.ipc"><span class="strong">Next Class</span></a></li> +<li><a href="../../../../../org/apache/hadoop/hbase/ipc/PriorityFunction.html" title="interface in org.apache.hadoop.hbase.ipc"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/apache/hadoop/hbase/ipc/MetricsHBaseServerWrapperImpl.html" target="_top">Frames</a></li>
