| <!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>RemoteProcedureDispatcher.RemoteProcedure (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="RemoteProcedureDispatcher.RemoteProcedure (Apache HBase 3.0.0-alpha-2-SNAPSHOT API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":18}; |
| 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/RemoteProcedureDispatcher.RemoteProcedure.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/procedure2/RemoteProcedureDispatcher.RemoteOperation.html" title="class in org.apache.hadoop.hbase.procedure2"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.TimeoutExecutorThread.html" title="class in org.apache.hadoop.hbase.procedure2"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" target="_top">Frames</a></li> |
| <li><a href="RemoteProcedureDispatcher.RemoteProcedure.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>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.procedure2</div> |
| <h2 title="Interface RemoteProcedureDispatcher.RemoteProcedure" class="title">Interface RemoteProcedureDispatcher.RemoteProcedure<TEnv,TRemote></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/master/assignment/AssignProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">AssignProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/replication/ClaimReplicationQueueRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.replication">ClaimReplicationQueueRemoteProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/assignment/CloseRegionProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">CloseRegionProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/assignment/OpenRegionProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">OpenRegionProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/replication/RefreshPeerProcedure.html" title="class in org.apache.hadoop.hbase.master.replication">RefreshPeerProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/assignment/RegionRemoteProcedureBase.html" title="class in org.apache.hadoop.hbase.master.assignment">RegionRemoteProcedureBase</a>, <a href="../../../../../org/apache/hadoop/hbase/master/assignment/RegionTransitionProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">RegionTransitionProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/procedure/ServerRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">ServerRemoteProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/procedure/SplitWALRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">SplitWALRemoteProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/procedure/SwitchRpcThrottleRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">SwitchRpcThrottleRemoteProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/replication/SyncReplicationReplayWALRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.replication">SyncReplicationReplayWALRemoteProcedure</a>, <a href="../../../../../org/apache/hadoop/hbase/master/assignment/UnassignProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">UnassignProcedure</a></dd> |
| </dl> |
| <dl> |
| <dt>Enclosing class:</dt> |
| <dd><a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureDispatcher</a><<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.html" title="type parameter in RemoteProcedureDispatcher">TEnv</a>,<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.html" title="type parameter in RemoteProcedureDispatcher">TRemote</a> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.html" title="type parameter in RemoteProcedureDispatcher">TRemote</a>>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public static interface <a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.html#line.237">RemoteProcedureDispatcher.RemoteProcedure</a><TEnv,TRemote></pre> |
| <div class="block">Remote procedure reference.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteOperation.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureDispatcher.RemoteOperation</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#remoteCallBuild-TEnv-TRemote-">remoteCallBuild</a></span>(<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TRemote</a> remote)</code> |
| <div class="block">For building the remote operation.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#remoteCallFailed-TEnv-TRemote-java.io.IOException-">remoteCallFailed</a></span>(<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TRemote</a> remote, |
| <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> exception)</code> |
| <div class="block">Called when the executeProcedure call is failed.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#remoteOperationCompleted-TEnv-">remoteOperationCompleted</a></span>(<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env)</code> |
| <div class="block">Called when RS tells the remote procedure is succeeded through the |
| <code>reportProcedureDone</code> method.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#remoteOperationFailed-TEnv-org.apache.hadoop.hbase.procedure2.RemoteProcedureException-">remoteOperationFailed</a></span>(<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureException.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureException</a> error)</code> |
| <div class="block">Called when RS tells the remote procedure is failed through the <code>reportProcedureDone</code> |
| method.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>default boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#storeInDispatchedQueue--">storeInDispatchedQueue</a></span>()</code> |
| <div class="block">Whether store this remote procedure in dispatched queue |
| only OpenRegionProcedure and CloseRegionProcedure return false since they are |
| not fully controlled by dispatcher</div> |
| </td> |
| </tr> |
| </table> |
| </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="remoteCallBuild-java.lang.Object-java.lang.Object-"> |
| <!-- --> |
| </a><a name="remoteCallBuild-TEnv-TRemote-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteCallBuild</h4> |
| <pre><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html?is-external=true" title="class or interface in java.util">Optional</a><<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteOperation.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureDispatcher.RemoteOperation</a>> <a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line.245">remoteCallBuild</a>(<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TRemote</a> remote)</pre> |
| <div class="block">For building the remote operation. |
| May be empty if no need to send remote call. Usually, this means the RemoteProcedure has been |
| finished already. This is possible, as we may have already sent the procedure to RS but then |
| the rpc connection is broken so the executeProcedures call fails, but the RS does receive the |
| procedure and execute it and then report back, before we retry again.</div> |
| </li> |
| </ul> |
| <a name="remoteCallFailed-java.lang.Object-java.lang.Object-java.io.IOException-"> |
| <!-- --> |
| </a><a name="remoteCallFailed-TEnv-TRemote-java.io.IOException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteCallFailed</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line.250">remoteCallFailed</a>(<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TRemote</a> remote, |
| <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> exception)</pre> |
| <div class="block">Called when the executeProcedure call is failed.</div> |
| </li> |
| </ul> |
| <a name="remoteOperationCompleted-java.lang.Object-"> |
| <!-- --> |
| </a><a name="remoteOperationCompleted-TEnv-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteOperationCompleted</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line.256">remoteOperationCompleted</a>(<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env)</pre> |
| <div class="block">Called when RS tells the remote procedure is succeeded through the |
| <code>reportProcedureDone</code> method.</div> |
| </li> |
| </ul> |
| <a name="remoteOperationFailed-java.lang.Object-org.apache.hadoop.hbase.procedure2.RemoteProcedureException-"> |
| <!-- --> |
| </a><a name="remoteOperationFailed-TEnv-org.apache.hadoop.hbase.procedure2.RemoteProcedureException-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>remoteOperationFailed</h4> |
| <pre>void <a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line.262">remoteOperationFailed</a>(<a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureException.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureException</a> error)</pre> |
| <div class="block">Called when RS tells the remote procedure is failed through the <code>reportProcedureDone</code> |
| method.</div> |
| </li> |
| </ul> |
| <a name="storeInDispatchedQueue--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>storeInDispatchedQueue</h4> |
| <pre>default boolean <a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line.269">storeInDispatchedQueue</a>()</pre> |
| <div class="block">Whether store this remote procedure in dispatched queue |
| only OpenRegionProcedure and CloseRegionProcedure return false since they are |
| not fully controlled by dispatcher</div> |
| </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/RemoteProcedureDispatcher.RemoteProcedure.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/procedure2/RemoteProcedureDispatcher.RemoteOperation.html" title="class in org.apache.hadoop.hbase.procedure2"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.TimeoutExecutorThread.html" title="class in org.apache.hadoop.hbase.procedure2"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html" target="_top">Frames</a></li> |
| <li><a href="RemoteProcedureDispatcher.RemoteProcedure.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>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> |
