| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>Source code</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta name="description" content="source: package: org.apache.hadoop.hbase.ipc, interface: HBaseRpcController"> |
| <meta name="generator" content="javadoc/SourceToHTMLConverter"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body class="source-page"> |
| <main role="main"> |
| <div class="source-container"> |
| <pre><span class="source-line-no">001</span><span id="line-1">/*</span> |
| <span class="source-line-no">002</span><span id="line-2"> * Licensed to the Apache Software Foundation (ASF) under one</span> |
| <span class="source-line-no">003</span><span id="line-3"> * or more contributor license agreements. See the NOTICE file</span> |
| <span class="source-line-no">004</span><span id="line-4"> * distributed with this work for additional information</span> |
| <span class="source-line-no">005</span><span id="line-5"> * regarding copyright ownership. The ASF licenses this file</span> |
| <span class="source-line-no">006</span><span id="line-6"> * to you under the Apache License, Version 2.0 (the</span> |
| <span class="source-line-no">007</span><span id="line-7"> * "License"); you may not use this file except in compliance</span> |
| <span class="source-line-no">008</span><span id="line-8"> * with the License. You may obtain a copy of the License at</span> |
| <span class="source-line-no">009</span><span id="line-9"> *</span> |
| <span class="source-line-no">010</span><span id="line-10"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <span class="source-line-no">011</span><span id="line-11"> *</span> |
| <span class="source-line-no">012</span><span id="line-12"> * Unless required by applicable law or agreed to in writing, software</span> |
| <span class="source-line-no">013</span><span id="line-13"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <span class="source-line-no">014</span><span id="line-14"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <span class="source-line-no">015</span><span id="line-15"> * See the License for the specific language governing permissions and</span> |
| <span class="source-line-no">016</span><span id="line-16"> * limitations under the License.</span> |
| <span class="source-line-no">017</span><span id="line-17"> */</span> |
| <span class="source-line-no">018</span><span id="line-18">package org.apache.hadoop.hbase.ipc;</span> |
| <span class="source-line-no">019</span><span id="line-19"></span> |
| <span class="source-line-no">020</span><span id="line-20">import java.io.IOException;</span> |
| <span class="source-line-no">021</span><span id="line-21">import java.util.Map;</span> |
| <span class="source-line-no">022</span><span id="line-22">import org.apache.hadoop.hbase.ExtendedCellScannable;</span> |
| <span class="source-line-no">023</span><span id="line-23">import org.apache.hadoop.hbase.ExtendedCellScanner;</span> |
| <span class="source-line-no">024</span><span id="line-24">import org.apache.hadoop.hbase.HBaseInterfaceAudience;</span> |
| <span class="source-line-no">025</span><span id="line-25">import org.apache.hadoop.hbase.HConstants;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.hadoop.hbase.TableName;</span> |
| <span class="source-line-no">027</span><span id="line-27">import org.apache.hadoop.hbase.client.RegionInfo;</span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">030</span><span id="line-30"></span> |
| <span class="source-line-no">031</span><span id="line-31">import org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback;</span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hbase.thirdparty.com.google.protobuf.RpcController;</span> |
| <span class="source-line-no">033</span><span id="line-33"></span> |
| <span class="source-line-no">034</span><span id="line-34">/**</span> |
| <span class="source-line-no">035</span><span id="line-35"> * Optionally carries Cells across the proxy/service interface down into ipc. On its way out it</span> |
| <span class="source-line-no">036</span><span id="line-36"> * optionally carries a set of result Cell data. We stick the Cells here when we want to avoid</span> |
| <span class="source-line-no">037</span><span id="line-37"> * having to protobuf them (for performance reasons). This class is used ferrying data across the</span> |
| <span class="source-line-no">038</span><span id="line-38"> * proxy/protobuf service chasm. Also does call timeout and on client-side, carries the target</span> |
| <span class="source-line-no">039</span><span id="line-39"> * RegionInfo we're making the call against if relevant (useful adding info to exceptions and logs).</span> |
| <span class="source-line-no">040</span><span id="line-40"> * Used by client and server ipc'ing.</span> |
| <span class="source-line-no">041</span><span id="line-41"> */</span> |
| <span class="source-line-no">042</span><span id="line-42">@InterfaceAudience.LimitedPrivate({ HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX,</span> |
| <span class="source-line-no">043</span><span id="line-43"> HBaseInterfaceAudience.REPLICATION })</span> |
| <span class="source-line-no">044</span><span id="line-44">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">045</span><span id="line-45">public interface HBaseRpcController extends RpcController, ExtendedCellScannable {</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /**</span> |
| <span class="source-line-no">048</span><span id="line-48"> * Only used to send cells to rpc server, the returned cells should be set by</span> |
| <span class="source-line-no">049</span><span id="line-49"> * {@link #setDone(ExtendedCellScanner)}.</span> |
| <span class="source-line-no">050</span><span id="line-50"> */</span> |
| <span class="source-line-no">051</span><span id="line-51"> void setCellScanner(ExtendedCellScanner cellScanner);</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /**</span> |
| <span class="source-line-no">054</span><span id="line-54"> * Set the priority for this operation.</span> |
| <span class="source-line-no">055</span><span id="line-55"> * @param priority Priority for this request; should fall roughly in the range</span> |
| <span class="source-line-no">056</span><span id="line-56"> * {@link HConstants#NORMAL_QOS} to {@link HConstants#HIGH_QOS}</span> |
| <span class="source-line-no">057</span><span id="line-57"> */</span> |
| <span class="source-line-no">058</span><span id="line-58"> void setPriority(int priority);</span> |
| <span class="source-line-no">059</span><span id="line-59"></span> |
| <span class="source-line-no">060</span><span id="line-60"> /**</span> |
| <span class="source-line-no">061</span><span id="line-61"> * Set the priority for this operation.</span> |
| <span class="source-line-no">062</span><span id="line-62"> * @param tn Set priority based off the table we are going against.</span> |
| <span class="source-line-no">063</span><span id="line-63"> */</span> |
| <span class="source-line-no">064</span><span id="line-64"> void setPriority(final TableName tn);</span> |
| <span class="source-line-no">065</span><span id="line-65"></span> |
| <span class="source-line-no">066</span><span id="line-66"> /** Returns The priority of this request */</span> |
| <span class="source-line-no">067</span><span id="line-67"> int getPriority();</span> |
| <span class="source-line-no">068</span><span id="line-68"></span> |
| <span class="source-line-no">069</span><span id="line-69"> int getCallTimeout();</span> |
| <span class="source-line-no">070</span><span id="line-70"></span> |
| <span class="source-line-no">071</span><span id="line-71"> void setCallTimeout(int callTimeout);</span> |
| <span class="source-line-no">072</span><span id="line-72"></span> |
| <span class="source-line-no">073</span><span id="line-73"> boolean hasCallTimeout();</span> |
| <span class="source-line-no">074</span><span id="line-74"></span> |
| <span class="source-line-no">075</span><span id="line-75"> /**</span> |
| <span class="source-line-no">076</span><span id="line-76"> * Get the map of request attributes</span> |
| <span class="source-line-no">077</span><span id="line-77"> */</span> |
| <span class="source-line-no">078</span><span id="line-78"> Map<String, byte[]> getRequestAttributes();</span> |
| <span class="source-line-no">079</span><span id="line-79"></span> |
| <span class="source-line-no">080</span><span id="line-80"> /**</span> |
| <span class="source-line-no">081</span><span id="line-81"> * Set the map of request attributes</span> |
| <span class="source-line-no">082</span><span id="line-82"> */</span> |
| <span class="source-line-no">083</span><span id="line-83"> void setRequestAttributes(Map<String, byte[]> requestAttributes);</span> |
| <span class="source-line-no">084</span><span id="line-84"></span> |
| <span class="source-line-no">085</span><span id="line-85"> /**</span> |
| <span class="source-line-no">086</span><span id="line-86"> * Set failed with an exception to pass on. For use in async rpc clients</span> |
| <span class="source-line-no">087</span><span id="line-87"> * @param e exception to set with</span> |
| <span class="source-line-no">088</span><span id="line-88"> */</span> |
| <span class="source-line-no">089</span><span id="line-89"> void setFailed(IOException e);</span> |
| <span class="source-line-no">090</span><span id="line-90"></span> |
| <span class="source-line-no">091</span><span id="line-91"> /**</span> |
| <span class="source-line-no">092</span><span id="line-92"> * Return the failed exception, null if not failed.</span> |
| <span class="source-line-no">093</span><span id="line-93"> */</span> |
| <span class="source-line-no">094</span><span id="line-94"> IOException getFailed();</span> |
| <span class="source-line-no">095</span><span id="line-95"></span> |
| <span class="source-line-no">096</span><span id="line-96"> /**</span> |
| <span class="source-line-no">097</span><span id="line-97"> * <b>IMPORTANT:</b> always call this method if the call finished without any exception to tell</span> |
| <span class="source-line-no">098</span><span id="line-98"> * the {@code HBaseRpcController} that we are done.</span> |
| <span class="source-line-no">099</span><span id="line-99"> */</span> |
| <span class="source-line-no">100</span><span id="line-100"> void setDone(ExtendedCellScanner cellScanner);</span> |
| <span class="source-line-no">101</span><span id="line-101"></span> |
| <span class="source-line-no">102</span><span id="line-102"> /**</span> |
| <span class="source-line-no">103</span><span id="line-103"> * A little different from the basic RpcController:</span> |
| <span class="source-line-no">104</span><span id="line-104"> * <ol></span> |
| <span class="source-line-no">105</span><span id="line-105"> * <li>You can register multiple callbacks to an {@code HBaseRpcController}.</li></span> |
| <span class="source-line-no">106</span><span id="line-106"> * <li>The callback will not be called if the rpc call is finished without any cancellation.</li></span> |
| <span class="source-line-no">107</span><span id="line-107"> * <li>You can call me at client side also.</li></span> |
| <span class="source-line-no">108</span><span id="line-108"> * </ol></span> |
| <span class="source-line-no">109</span><span id="line-109"> */</span> |
| <span class="source-line-no">110</span><span id="line-110"> @Override</span> |
| <span class="source-line-no">111</span><span id="line-111"> void notifyOnCancel(RpcCallback<Object> callback);</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> interface CancellationCallback {</span> |
| <span class="source-line-no">114</span><span id="line-114"> void run(boolean cancelled) throws IOException;</span> |
| <span class="source-line-no">115</span><span id="line-115"> }</span> |
| <span class="source-line-no">116</span><span id="line-116"></span> |
| <span class="source-line-no">117</span><span id="line-117"> /**</span> |
| <span class="source-line-no">118</span><span id="line-118"> * If not cancelled, add the callback to cancellation callback list. And then execute the action</span> |
| <span class="source-line-no">119</span><span id="line-119"> * with the cancellation state as a parameter. The implementation should guarantee that the</span> |
| <span class="source-line-no">120</span><span id="line-120"> * cancellation state does not change during this call.</span> |
| <span class="source-line-no">121</span><span id="line-121"> */</span> |
| <span class="source-line-no">122</span><span id="line-122"> void notifyOnCancel(RpcCallback<Object> callback, CancellationCallback action) throws IOException;</span> |
| <span class="source-line-no">123</span><span id="line-123"></span> |
| <span class="source-line-no">124</span><span id="line-124"> /** Returns True if this Controller is carrying the RPC target Region's RegionInfo. */</span> |
| <span class="source-line-no">125</span><span id="line-125"> default boolean hasRegionInfo() {</span> |
| <span class="source-line-no">126</span><span id="line-126"> return false;</span> |
| <span class="source-line-no">127</span><span id="line-127"> }</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /** Returns Target Region's RegionInfo or null if not available or pertinent. */</span> |
| <span class="source-line-no">130</span><span id="line-130"> default RegionInfo getRegionInfo() {</span> |
| <span class="source-line-no">131</span><span id="line-131"> return null;</span> |
| <span class="source-line-no">132</span><span id="line-132"> }</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> /** Sets Region's table name. */</span> |
| <span class="source-line-no">135</span><span id="line-135"> default void setTableName(TableName tableName) {</span> |
| <span class="source-line-no">136</span><span id="line-136"></span> |
| <span class="source-line-no">137</span><span id="line-137"> }</span> |
| <span class="source-line-no">138</span><span id="line-138"></span> |
| <span class="source-line-no">139</span><span id="line-139"> /** Returns Region's table name or null if not available or pertinent. */</span> |
| <span class="source-line-no">140</span><span id="line-140"> default TableName getTableName() {</span> |
| <span class="source-line-no">141</span><span id="line-141"> return null;</span> |
| <span class="source-line-no">142</span><span id="line-142"> }</span> |
| <span class="source-line-no">143</span><span id="line-143">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
