| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>/**<a name="line.1"></a> |
| <span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a> |
| <span class="sourceLineNo">003</span> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * distributed with this work for additional information<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * "License"); you may not use this file except in compliance<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * with the License. You may obtain a copy of the License at<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> *<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * See the License for the specific language governing permissions and<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * limitations under the License.<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> */<a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.hadoop.hbase.ipc;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.net.InetAddress;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.util.Optional;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.apache.yetus.audience.InterfaceAudience;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.VersionInfo;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import org.apache.hadoop.hbase.security.User;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>/**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * Interface of all necessary to carry out a RPC service invocation on the server. This interface<a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * focus on the information needed or obtained during the actual execution of the service method.<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> */<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>@InterfaceAudience.Private<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>public interface RpcCallContext {<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> /**<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * Check if the caller who made this IPC call has disconnected.<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * If called from outside the context of IPC, this does nothing.<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * @return &lt; 0 if the caller is still connected. The time in ms<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * since the disconnection otherwise<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> long disconnectSince();<a name="line.39"></a> |
| <span class="sourceLineNo">040</span><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> /**<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * If the client connected and specified a codec to use, then we will use this codec making<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * cellblocks to return. If the client did not specify a codec, we assume it does not support<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * cellblocks and will return all content protobuf'd (though it makes our serving slower).<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * We need to ask this question per call because a server could be hosting both clients that<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * support cellblocks while fielding requests from clients that do not.<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @return True if the client supports cellblocks, else return all content in pb<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> boolean isClientCellBlockSupported();<a name="line.49"></a> |
| <span class="sourceLineNo">050</span><a name="line.50"></a> |
| <span class="sourceLineNo">051</span> /**<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * Returns the user credentials associated with the current RPC request or not present if no<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * credentials were provided.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @return A User<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> */<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> Optional<User> getRequestUser();<a name="line.56"></a> |
| <span class="sourceLineNo">057</span><a name="line.57"></a> |
| <span class="sourceLineNo">058</span> /**<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * @return Current request's user name or not present if none ongoing.<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> */<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> default Optional<String> getRequestUserName() {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> return getRequestUser().map(User::getShortName);<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> }<a name="line.63"></a> |
| <span class="sourceLineNo">064</span><a name="line.64"></a> |
| <span class="sourceLineNo">065</span> /**<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> * @return Address of remote client in this call<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> */<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> InetAddress getRemoteAddress();<a name="line.68"></a> |
| <span class="sourceLineNo">069</span><a name="line.69"></a> |
| <span class="sourceLineNo">070</span> /**<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * @return the client version info, or null if the information is not present<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> */<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> VersionInfo getClientVersionInfo();<a name="line.73"></a> |
| <span class="sourceLineNo">074</span><a name="line.74"></a> |
| <span class="sourceLineNo">075</span> /**<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * Sets a callback which has to be executed at the end of this RPC call. Such a callback is an<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> * optional one for any Rpc call.<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> *<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * @param callback<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> */<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> void setCallBack(RpcCallback callback);<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> boolean isRetryImmediatelySupported();<a name="line.83"></a> |
| <span class="sourceLineNo">084</span><a name="line.84"></a> |
| <span class="sourceLineNo">085</span> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * The size of response cells that have been accumulated so far.<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * This along with the corresponding increment call is used to ensure that multi's or<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * scans dont get too excessively large<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> */<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> long getResponseCellSize();<a name="line.90"></a> |
| <span class="sourceLineNo">091</span><a name="line.91"></a> |
| <span class="sourceLineNo">092</span> /**<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * Add on the given amount to the retained cell size.<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> *<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * This is not thread safe and not synchronized at all. If this is used by more than one thread<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * then everything will break. Since this is called for every row synchronization would be too<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * onerous.<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> */<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> void incrementResponseCellSize(long cellSize);<a name="line.99"></a> |
| <span class="sourceLineNo">100</span><a name="line.100"></a> |
| <span class="sourceLineNo">101</span> long getResponseBlockSize();<a name="line.101"></a> |
| <span class="sourceLineNo">102</span><a name="line.102"></a> |
| <span class="sourceLineNo">103</span> void incrementResponseBlockSize(long blockSize);<a name="line.103"></a> |
| <span class="sourceLineNo">104</span><a name="line.104"></a> |
| <span class="sourceLineNo">105</span> long getResponseExceptionSize();<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> void incrementResponseExceptionSize(long exceptionSize);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span>}<a name="line.107"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |