| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>RemoteProcedureDispatcher.RemoteProcedure (Apache HBase 4.0.0-alpha-1-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.hadoop.hbase.procedure2, class: RemoteProcedureDispatcher, interface: RemoteProcedure"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.hadoop.hbase.procedure2</a></div> |
| <h1 title="Interface RemoteProcedureDispatcher.RemoteProcedure" class="title">Interface RemoteProcedureDispatcher.RemoteProcedure<TEnv,<wbr>TRemote></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="../master/assignment/AssignProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">AssignProcedure</a></code>, <code><a href="../master/replication/ClaimReplicationQueueRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.replication">ClaimReplicationQueueRemoteProcedure</a></code>, <code><a href="../master/assignment/CloseRegionProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">CloseRegionProcedure</a></code>, <code><a href="../master/procedure/FlushRegionProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">FlushRegionProcedure</a></code>, <code><a href="../master/assignment/OpenRegionProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">OpenRegionProcedure</a></code>, <code><a href="../master/replication/RefreshPeerProcedure.html" title="class in org.apache.hadoop.hbase.master.replication">RefreshPeerProcedure</a></code>, <code><a href="../master/assignment/RegionRemoteProcedureBase.html" title="class in org.apache.hadoop.hbase.master.assignment">RegionRemoteProcedureBase</a></code>, <code><a href="../master/assignment/RegionTransitionProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">RegionTransitionProcedure</a></code>, <code><a href="../master/procedure/ServerRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">ServerRemoteProcedure</a></code>, <code><a href="../master/procedure/SnapshotRegionProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">SnapshotRegionProcedure</a></code>, <code><a href="../master/procedure/SnapshotVerifyProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">SnapshotVerifyProcedure</a></code>, <code><a href="../master/procedure/SplitWALRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">SplitWALRemoteProcedure</a></code>, <code><a href="../master/procedure/SwitchRpcThrottleRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.procedure">SwitchRpcThrottleRemoteProcedure</a></code>, <code><a href="../master/replication/SyncReplicationReplayWALRemoteProcedure.html" title="class in org.apache.hadoop.hbase.master.replication">SyncReplicationReplayWALRemoteProcedure</a></code>, <code><a href="../master/assignment/UnassignProcedure.html" title="class in org.apache.hadoop.hbase.master.assignment">UnassignProcedure</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>Enclosing class:</dt> |
| <dd><a href="RemoteProcedureDispatcher.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureDispatcher</a><<a href="RemoteProcedureDispatcher.html" title="type parameter in RemoteProcedureDispatcher">TEnv</a>,<wbr><a href="RemoteProcedureDispatcher.html" title="type parameter in RemoteProcedureDispatcher">TRemote</a> extends <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Comparable.html" title="class or interface in java.lang" class="external-link">Comparable</a><<a href="RemoteProcedureDispatcher.html" title="type parameter in RemoteProcedureDispatcher">TRemote</a>>></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public static interface </span><span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.html#line-246">RemoteProcedureDispatcher.RemoteProcedure</a><TEnv,<wbr>TRemote></span></div> |
| <div class="block">Remote procedure reference.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab5" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab5', 3)" class="table-tab">Default Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="RemoteProcedureDispatcher.RemoteOperation.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureDispatcher.RemoteOperation</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#remoteCallBuild(TEnv,TRemote)" class="member-name-link">remoteCallBuild</a><wbr>(<a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TRemote</a> remote)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">For building the remote operation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#remoteCallFailed(TEnv,TRemote,java.io.IOException)" class="member-name-link">remoteCallFailed</a><wbr>(<a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TRemote</a> remote, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a> exception)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when the executeProcedure call is failed.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#remoteOperationCompleted(TEnv)" class="member-name-link">remoteOperationCompleted</a><wbr>(<a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when RS tells the remote procedure is succeeded through the |
| <code>reportProcedureDone</code> method.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#remoteOperationFailed(TEnv,org.apache.hadoop.hbase.procedure2.RemoteProcedureException)" class="member-name-link">remoteOperationFailed</a><wbr>(<a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="RemoteProcedureException.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureException</a> error)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Called when RS tells the remote procedure is failed through the <code>reportProcedureDone</code> |
| method.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code>default boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"><code><a href="#storeInDispatchedQueue()" class="member-name-link">storeInDispatchedQueue</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab5"> |
| <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> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="remoteCallBuild(TEnv,TRemote)"> |
| <h3 id="remoteCallBuild(java.lang.Object,java.lang.Object)">remoteCallBuild</h3> |
| <div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Optional.html" title="class or interface in java.util" class="external-link">Optional</a><<a href="RemoteProcedureDispatcher.RemoteOperation.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureDispatcher.RemoteOperation</a>></span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line-254">remoteCallBuild</a></span><wbr><span class="parameters">(<a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TRemote</a> remote)</span></div> |
| <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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remoteCallFailed(TEnv,TRemote,java.io.IOException)"> |
| <h3 id="remoteCallFailed(java.lang.Object,java.lang.Object,java.io.IOException)">remoteCallFailed</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line-259">remoteCallFailed</a></span><wbr><span class="parameters">(<a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TRemote</a> remote, |
| <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a> exception)</span></div> |
| <div class="block">Called when the executeProcedure call is failed.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remoteOperationCompleted(TEnv)"> |
| <h3 id="remoteOperationCompleted(java.lang.Object)">remoteOperationCompleted</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line-265">remoteOperationCompleted</a></span><wbr><span class="parameters">(<a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env)</span></div> |
| <div class="block">Called when RS tells the remote procedure is succeeded through the |
| <code>reportProcedureDone</code> method.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="remoteOperationFailed(TEnv,org.apache.hadoop.hbase.procedure2.RemoteProcedureException)"> |
| <h3 id="remoteOperationFailed(java.lang.Object,org.apache.hadoop.hbase.procedure2.RemoteProcedureException)">remoteOperationFailed</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line-271">remoteOperationFailed</a></span><wbr><span class="parameters">(<a href="RemoteProcedureDispatcher.RemoteProcedure.html" title="type parameter in RemoteProcedureDispatcher.RemoteProcedure">TEnv</a> env, |
| <a href="RemoteProcedureException.html" title="class in org.apache.hadoop.hbase.procedure2">RemoteProcedureException</a> error)</span></div> |
| <div class="block">Called when RS tells the remote procedure is failed through the <code>reportProcedureDone</code> |
| method.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="storeInDispatchedQueue()"> |
| <h3>storeInDispatchedQueue</h3> |
| <div class="member-signature"><span class="modifiers">default</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../../src-html/org/apache/hadoop/hbase/procedure2/RemoteProcedureDispatcher.RemoteProcedure.html#line-277">storeInDispatchedQueue</a></span>()</div> |
| <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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2007–2020 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
