| <!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: RpcCall"> |
| <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.conf.Configuration;</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.yetus.audience.InterfaceAudience;</span> |
| <span class="source-line-no">026</span><span id="line-26">import org.apache.yetus.audience.InterfaceStability;</span> |
| <span class="source-line-no">027</span><span id="line-27"></span> |
| <span class="source-line-no">028</span><span id="line-28">import org.apache.hbase.thirdparty.com.google.protobuf.BlockingService;</span> |
| <span class="source-line-no">029</span><span id="line-29">import org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor;</span> |
| <span class="source-line-no">030</span><span id="line-30">import org.apache.hbase.thirdparty.com.google.protobuf.Message;</span> |
| <span class="source-line-no">031</span><span id="line-31"></span> |
| <span class="source-line-no">032</span><span id="line-32">import org.apache.hadoop.hbase.shaded.protobuf.generated.RPCProtos.RequestHeader;</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"> * Interface of all necessary to carry out a RPC method invocation on the server.</span> |
| <span class="source-line-no">036</span><span id="line-36"> */</span> |
| <span class="source-line-no">037</span><span id="line-37">@InterfaceAudience.LimitedPrivate({ HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX })</span> |
| <span class="source-line-no">038</span><span id="line-38">@InterfaceStability.Evolving</span> |
| <span class="source-line-no">039</span><span id="line-39">public interface RpcCall extends RpcCallContext {</span> |
| <span class="source-line-no">040</span><span id="line-40"></span> |
| <span class="source-line-no">041</span><span id="line-41"> /** Returns The service of this call. */</span> |
| <span class="source-line-no">042</span><span id="line-42"> BlockingService getService();</span> |
| <span class="source-line-no">043</span><span id="line-43"></span> |
| <span class="source-line-no">044</span><span id="line-44"> /** Returns The service method. */</span> |
| <span class="source-line-no">045</span><span id="line-45"> MethodDescriptor getMethod();</span> |
| <span class="source-line-no">046</span><span id="line-46"></span> |
| <span class="source-line-no">047</span><span id="line-47"> /** Returns The call parameter message. */</span> |
| <span class="source-line-no">048</span><span id="line-48"> Message getParam();</span> |
| <span class="source-line-no">049</span><span id="line-49"></span> |
| <span class="source-line-no">050</span><span id="line-50"> /** Returns The CellScanner that can carry input and result payload. */</span> |
| <span class="source-line-no">051</span><span id="line-51"> ExtendedCellScanner getCellScanner();</span> |
| <span class="source-line-no">052</span><span id="line-52"></span> |
| <span class="source-line-no">053</span><span id="line-53"> /** Returns The timestamp when the call is constructed. */</span> |
| <span class="source-line-no">054</span><span id="line-54"> long getReceiveTime();</span> |
| <span class="source-line-no">055</span><span id="line-55"></span> |
| <span class="source-line-no">056</span><span id="line-56"> /** Returns The time when the call starts to be executed. */</span> |
| <span class="source-line-no">057</span><span id="line-57"> long getStartTime();</span> |
| <span class="source-line-no">058</span><span id="line-58"></span> |
| <span class="source-line-no">059</span><span id="line-59"> /**</span> |
| <span class="source-line-no">060</span><span id="line-60"> * Set the time when the call starts to be executed.</span> |
| <span class="source-line-no">061</span><span id="line-61"> */</span> |
| <span class="source-line-no">062</span><span id="line-62"> void setStartTime(long startTime);</span> |
| <span class="source-line-no">063</span><span id="line-63"></span> |
| <span class="source-line-no">064</span><span id="line-64"> /** Returns The timeout of this call. */</span> |
| <span class="source-line-no">065</span><span id="line-65"> int getTimeout();</span> |
| <span class="source-line-no">066</span><span id="line-66"></span> |
| <span class="source-line-no">067</span><span id="line-67"> /** Returns The Priority of this call. */</span> |
| <span class="source-line-no">068</span><span id="line-68"> int getPriority();</span> |
| <span class="source-line-no">069</span><span id="line-69"></span> |
| <span class="source-line-no">070</span><span id="line-70"> /**</span> |
| <span class="source-line-no">071</span><span id="line-71"> * Return the deadline of this call. If we can not complete this call in time, we can throw a</span> |
| <span class="source-line-no">072</span><span id="line-72"> * TimeoutIOException and RPCServer will drop it.</span> |
| <span class="source-line-no">073</span><span id="line-73"> * @return The system timestamp of deadline.</span> |
| <span class="source-line-no">074</span><span id="line-74"> */</span> |
| <span class="source-line-no">075</span><span id="line-75"> long getDeadline();</span> |
| <span class="source-line-no">076</span><span id="line-76"></span> |
| <span class="source-line-no">077</span><span id="line-77"> /**</span> |
| <span class="source-line-no">078</span><span id="line-78"> * Used to calculate the request call queue size. If the total request call size exceeds a limit,</span> |
| <span class="source-line-no">079</span><span id="line-79"> * the call will be rejected.</span> |
| <span class="source-line-no">080</span><span id="line-80"> * @return The raw size of this call.</span> |
| <span class="source-line-no">081</span><span id="line-81"> */</span> |
| <span class="source-line-no">082</span><span id="line-82"> long getSize();</span> |
| <span class="source-line-no">083</span><span id="line-83"></span> |
| <span class="source-line-no">084</span><span id="line-84"> /** Returns The request header of this call. */</span> |
| <span class="source-line-no">085</span><span id="line-85"> RequestHeader getHeader();</span> |
| <span class="source-line-no">086</span><span id="line-86"></span> |
| <span class="source-line-no">087</span><span id="line-87"> /**</span> |
| <span class="source-line-no">088</span><span id="line-88"> * Returns the map of attributes specified when building the Connection.</span> |
| <span class="source-line-no">089</span><span id="line-89"> * @see org.apache.hadoop.hbase.client.ConnectionFactory#createConnection(Configuration,</span> |
| <span class="source-line-no">090</span><span id="line-90"> * ExecutorService, User, Map)</span> |
| <span class="source-line-no">091</span><span id="line-91"> */</span> |
| <span class="source-line-no">092</span><span id="line-92"> Map<String, byte[]> getConnectionAttributes();</span> |
| <span class="source-line-no">093</span><span id="line-93"></span> |
| <span class="source-line-no">094</span><span id="line-94"> /**</span> |
| <span class="source-line-no">095</span><span id="line-95"> * Returns the map of attributes specified when building the request. This map is lazily evaluated</span> |
| <span class="source-line-no">096</span><span id="line-96"> * so if you only need a single attribute then it may be cheaper to use</span> |
| <span class="source-line-no">097</span><span id="line-97"> * {@link #getRequestAttribute(String)}</span> |
| <span class="source-line-no">098</span><span id="line-98"> * @see org.apache.hadoop.hbase.client.TableBuilder#setRequestAttribute(String, byte[])</span> |
| <span class="source-line-no">099</span><span id="line-99"> */</span> |
| <span class="source-line-no">100</span><span id="line-100"> Map<String, byte[]> getRequestAttributes();</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"> * Returns a single request attribute value, or null if no value is present. If you need many</span> |
| <span class="source-line-no">104</span><span id="line-104"> * request attributes then you should fetch the lazily evaluated map via</span> |
| <span class="source-line-no">105</span><span id="line-105"> * {@link #getRequestAttributes()}</span> |
| <span class="source-line-no">106</span><span id="line-106"> * @see org.apache.hadoop.hbase.client.TableBuilder#setRequestAttribute(String, byte[])</span> |
| <span class="source-line-no">107</span><span id="line-107"> */</span> |
| <span class="source-line-no">108</span><span id="line-108"> byte[] getRequestAttribute(String key);</span> |
| <span class="source-line-no">109</span><span id="line-109"></span> |
| <span class="source-line-no">110</span><span id="line-110"> /** Returns Port of remote address in this call */</span> |
| <span class="source-line-no">111</span><span id="line-111"> int getRemotePort();</span> |
| <span class="source-line-no">112</span><span id="line-112"></span> |
| <span class="source-line-no">113</span><span id="line-113"> /**</span> |
| <span class="source-line-no">114</span><span id="line-114"> * Set the response resulting from this RPC call.</span> |
| <span class="source-line-no">115</span><span id="line-115"> * @param param The result message as response.</span> |
| <span class="source-line-no">116</span><span id="line-116"> * @param cells The CellScanner that possibly carries the payload.</span> |
| <span class="source-line-no">117</span><span id="line-117"> * @param errorThrowable The error Throwable resulting from the call.</span> |
| <span class="source-line-no">118</span><span id="line-118"> * @param error Extra error message.</span> |
| <span class="source-line-no">119</span><span id="line-119"> */</span> |
| <span class="source-line-no">120</span><span id="line-120"> void setResponse(Message param, ExtendedCellScanner cells, Throwable errorThrowable,</span> |
| <span class="source-line-no">121</span><span id="line-121"> String error);</span> |
| <span class="source-line-no">122</span><span id="line-122"></span> |
| <span class="source-line-no">123</span><span id="line-123"> /**</span> |
| <span class="source-line-no">124</span><span id="line-124"> * Send the response of this RPC call. Implementation provides the underlying facility</span> |
| <span class="source-line-no">125</span><span id="line-125"> * (connection, etc) to send.</span> |
| <span class="source-line-no">126</span><span id="line-126"> */</span> |
| <span class="source-line-no">127</span><span id="line-127"> void sendResponseIfReady() throws IOException;</span> |
| <span class="source-line-no">128</span><span id="line-128"></span> |
| <span class="source-line-no">129</span><span id="line-129"> /**</span> |
| <span class="source-line-no">130</span><span id="line-130"> * Do the necessary cleanup after the call if needed.</span> |
| <span class="source-line-no">131</span><span id="line-131"> */</span> |
| <span class="source-line-no">132</span><span id="line-132"> void cleanup();</span> |
| <span class="source-line-no">133</span><span id="line-133"></span> |
| <span class="source-line-no">134</span><span id="line-134"> /** Returns A short string format of this call without possibly lengthy params */</span> |
| <span class="source-line-no">135</span><span id="line-135"> String toShortString();</span> |
| <span class="source-line-no">136</span><span id="line-136"></span> |
| <span class="source-line-no">137</span><span id="line-137"> void updateFsReadTime(long latencyMillis);</span> |
| <span class="source-line-no">138</span><span id="line-138"></span> |
| <span class="source-line-no">139</span><span id="line-139"> long getFsReadTime();</span> |
| <span class="source-line-no">140</span><span id="line-140">}</span> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
