devapidocs/src-html/org/apache/hadoop/hbase/ipc/RpcClient.html - hbase-site - Git at Google

 <!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.io.Closeable;<a name="line.20"></a>
 <span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.ServerName;<a name="line.21"></a>
 <span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.security.User;<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><a name="line.24"></a>
 <span class="sourceLineNo">025</span>import org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel;<a name="line.25"></a>
 <span class="sourceLineNo">026</span>import org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel;<a name="line.26"></a>
 <span class="sourceLineNo">027</span><a name="line.27"></a>
 <span class="sourceLineNo">028</span>/**<a name="line.28"></a>
 <span class="sourceLineNo">029</span> * Interface for RpcClient implementations so ConnectionManager can handle it.<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 RpcClient extends Closeable {<a name="line.32"></a>
 <span class="sourceLineNo">033</span>  String FAILED_SERVER_EXPIRY_KEY = "hbase.ipc.client.failed.servers.expiry";<a name="line.33"></a>
 <span class="sourceLineNo">034</span>  int FAILED_SERVER_EXPIRY_DEFAULT = 2000;<a name="line.34"></a>
 <span class="sourceLineNo">035</span>  String IDLE_TIME = "hbase.ipc.client.connection.minIdleTimeBeforeClose";<a name="line.35"></a>
 <span class="sourceLineNo">036</span>  String IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY =<a name="line.36"></a>
 <span class="sourceLineNo">037</span>    "hbase.ipc.client.fallback-to-simple-auth-allowed";<a name="line.37"></a>
 <span class="sourceLineNo">038</span>  boolean IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT = false;<a name="line.38"></a>
 <span class="sourceLineNo">039</span>  String SPECIFIC_WRITE_THREAD = "hbase.ipc.client.specificThreadForWriting";<a name="line.39"></a>
 <span class="sourceLineNo">040</span>  String DEFAULT_CODEC_CLASS = "hbase.client.default.rpc.codec";<a name="line.40"></a>
 <span class="sourceLineNo">041</span><a name="line.41"></a>
 <span class="sourceLineNo">042</span>  String SOCKET_TIMEOUT_CONNECT = "hbase.ipc.client.socket.timeout.connect";<a name="line.42"></a>
 <span class="sourceLineNo">043</span>  /**<a name="line.43"></a>
 <span class="sourceLineNo">044</span>   * How long we wait when we wait for an answer. It's not the operation time, it's the time we wait<a name="line.44"></a>
 <span class="sourceLineNo">045</span>   * when we start to receive an answer, when the remote write starts to send the data.<a name="line.45"></a>
 <span class="sourceLineNo">046</span>   */<a name="line.46"></a>
 <span class="sourceLineNo">047</span>  String SOCKET_TIMEOUT_READ = "hbase.ipc.client.socket.timeout.read";<a name="line.47"></a>
 <span class="sourceLineNo">048</span>  String SOCKET_TIMEOUT_WRITE = "hbase.ipc.client.socket.timeout.write";<a name="line.48"></a>
 <span class="sourceLineNo">049</span>  int DEFAULT_SOCKET_TIMEOUT_CONNECT = 10000; // 10 seconds<a name="line.49"></a>
 <span class="sourceLineNo">050</span>  int DEFAULT_SOCKET_TIMEOUT_READ = 20000; // 20 seconds<a name="line.50"></a>
 <span class="sourceLineNo">051</span>  int DEFAULT_SOCKET_TIMEOUT_WRITE = 60000; // 60 seconds<a name="line.51"></a>
 <span class="sourceLineNo">052</span><a name="line.52"></a>
 <span class="sourceLineNo">053</span>  // Used by the server, for compatibility with old clients.<a name="line.53"></a>
 <span class="sourceLineNo">054</span>  // The client in 0.99+ does not ping the server.<a name="line.54"></a>
 <span class="sourceLineNo">055</span>  int PING_CALL_ID = -1;<a name="line.55"></a>
 <span class="sourceLineNo">056</span><a name="line.56"></a>
 <span class="sourceLineNo">057</span>  /**<a name="line.57"></a>
 <span class="sourceLineNo">058</span>   * Creates a "channel" that can be used by a blocking protobuf service. Useful setting up protobuf<a name="line.58"></a>
 <span class="sourceLineNo">059</span>   * blocking stubs.<a name="line.59"></a>
 <span class="sourceLineNo">060</span>   * @param sn         server name describing location of server<a name="line.60"></a>
 <span class="sourceLineNo">061</span>   * @param user       which is to use the connection<a name="line.61"></a>
 <span class="sourceLineNo">062</span>   * @param rpcTimeout default rpc operation timeout<a name="line.62"></a>
 <span class="sourceLineNo">063</span>   * @return A blocking rpc channel that goes via this rpc client instance.<a name="line.63"></a>
 <span class="sourceLineNo">064</span>   */<a name="line.64"></a>
 <span class="sourceLineNo">065</span>  BlockingRpcChannel createBlockingRpcChannel(ServerName sn, User user, int rpcTimeout);<a name="line.65"></a>
 <span class="sourceLineNo">066</span><a name="line.66"></a>
 <span class="sourceLineNo">067</span>  /**<a name="line.67"></a>
 <span class="sourceLineNo">068</span>   * Creates a "channel" that can be used by a protobuf service. Useful setting up protobuf stubs.<a name="line.68"></a>
 <span class="sourceLineNo">069</span>   * @param sn         server name describing location of server<a name="line.69"></a>
 <span class="sourceLineNo">070</span>   * @param user       which is to use the connection<a name="line.70"></a>
 <span class="sourceLineNo">071</span>   * @param rpcTimeout default rpc operation timeout<a name="line.71"></a>
 <span class="sourceLineNo">072</span>   * @return A rpc channel that goes via this rpc client instance.<a name="line.72"></a>
 <span class="sourceLineNo">073</span>   */<a name="line.73"></a>
 <span class="sourceLineNo">074</span>  RpcChannel createRpcChannel(final ServerName sn, final User user, int rpcTimeout);<a name="line.74"></a>
 <span class="sourceLineNo">075</span><a name="line.75"></a>
 <span class="sourceLineNo">076</span>  /**<a name="line.76"></a>
 <span class="sourceLineNo">077</span>   * Interrupt the connections to the given server. This should be called if the server is known as<a name="line.77"></a>
 <span class="sourceLineNo">078</span>   * actually dead. This will not prevent current operation to be retried, and, depending on their<a name="line.78"></a>
 <span class="sourceLineNo">079</span>   * own behavior, they may retry on the same server. This can be a feature, for example at startup.<a name="line.79"></a>
 <span class="sourceLineNo">080</span>   * In any case, they're likely to get connection refused (if the process died) or no route to<a name="line.80"></a>
 <span class="sourceLineNo">081</span>   * host: i.e. their next retries should be faster and with a safe exception.<a name="line.81"></a>
 <span class="sourceLineNo">082</span>   * @param sn server location to cancel connections of<a name="line.82"></a>
 <span class="sourceLineNo">083</span>   */<a name="line.83"></a>
 <span class="sourceLineNo">084</span>  void cancelConnections(ServerName sn);<a name="line.84"></a>
 <span class="sourceLineNo">085</span><a name="line.85"></a>
 <span class="sourceLineNo">086</span>  /**<a name="line.86"></a>
 <span class="sourceLineNo">087</span>   * Stop all threads related to this client. No further calls may be made using this client.<a name="line.87"></a>
 <span class="sourceLineNo">088</span>   */<a name="line.88"></a>
 <span class="sourceLineNo">089</span>  @Override<a name="line.89"></a>
 <span class="sourceLineNo">090</span>  void close();<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>   * Return true when this client uses a {@link org.apache.hadoop.hbase.codec.Codec} and so supports<a name="line.93"></a>
 <span class="sourceLineNo">094</span>   * cell blocks.<a name="line.94"></a>
 <span class="sourceLineNo">095</span>   */<a name="line.95"></a>
 <span class="sourceLineNo">096</span>  boolean hasCellBlockSupport();<a name="line.96"></a>
 <span class="sourceLineNo">097</span>}<a name="line.97"></a>


 </pre>
 </div>
 </body>
 </html>
	<!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.io.Closeable;<a name="line.20"></a>
	<span class="sourceLineNo">021</span>import org.apache.hadoop.hbase.ServerName;<a name="line.21"></a>
	<span class="sourceLineNo">022</span>import org.apache.hadoop.hbase.security.User;<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><a name="line.24"></a>
	<span class="sourceLineNo">025</span>import org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel;<a name="line.25"></a>
	<span class="sourceLineNo">026</span>import org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel;<a name="line.26"></a>
	<span class="sourceLineNo">027</span><a name="line.27"></a>
	<span class="sourceLineNo">028</span>/**<a name="line.28"></a>
	<span class="sourceLineNo">029</span> * Interface for RpcClient implementations so ConnectionManager can handle it.<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 RpcClient extends Closeable {<a name="line.32"></a>
	<span class="sourceLineNo">033</span> String FAILED_SERVER_EXPIRY_KEY = "hbase.ipc.client.failed.servers.expiry";<a name="line.33"></a>
	<span class="sourceLineNo">034</span> int FAILED_SERVER_EXPIRY_DEFAULT = 2000;<a name="line.34"></a>
	<span class="sourceLineNo">035</span> String IDLE_TIME = "hbase.ipc.client.connection.minIdleTimeBeforeClose";<a name="line.35"></a>
	<span class="sourceLineNo">036</span> String IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY =<a name="line.36"></a>
	<span class="sourceLineNo">037</span> "hbase.ipc.client.fallback-to-simple-auth-allowed";<a name="line.37"></a>
	<span class="sourceLineNo">038</span> boolean IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT = false;<a name="line.38"></a>
	<span class="sourceLineNo">039</span> String SPECIFIC_WRITE_THREAD = "hbase.ipc.client.specificThreadForWriting";<a name="line.39"></a>
	<span class="sourceLineNo">040</span> String DEFAULT_CODEC_CLASS = "hbase.client.default.rpc.codec";<a name="line.40"></a>
	<span class="sourceLineNo">041</span><a name="line.41"></a>
	<span class="sourceLineNo">042</span> String SOCKET_TIMEOUT_CONNECT = "hbase.ipc.client.socket.timeout.connect";<a name="line.42"></a>
	<span class="sourceLineNo">043</span> /**<a name="line.43"></a>
	<span class="sourceLineNo">044</span> * How long we wait when we wait for an answer. It's not the operation time, it's the time we wait<a name="line.44"></a>
	<span class="sourceLineNo">045</span> * when we start to receive an answer, when the remote write starts to send the data.<a name="line.45"></a>
	<span class="sourceLineNo">046</span> */<a name="line.46"></a>
	<span class="sourceLineNo">047</span> String SOCKET_TIMEOUT_READ = "hbase.ipc.client.socket.timeout.read";<a name="line.47"></a>
	<span class="sourceLineNo">048</span> String SOCKET_TIMEOUT_WRITE = "hbase.ipc.client.socket.timeout.write";<a name="line.48"></a>
	<span class="sourceLineNo">049</span> int DEFAULT_SOCKET_TIMEOUT_CONNECT = 10000; // 10 seconds<a name="line.49"></a>
	<span class="sourceLineNo">050</span> int DEFAULT_SOCKET_TIMEOUT_READ = 20000; // 20 seconds<a name="line.50"></a>
	<span class="sourceLineNo">051</span> int DEFAULT_SOCKET_TIMEOUT_WRITE = 60000; // 60 seconds<a name="line.51"></a>
	<span class="sourceLineNo">052</span><a name="line.52"></a>
	<span class="sourceLineNo">053</span> // Used by the server, for compatibility with old clients.<a name="line.53"></a>
	<span class="sourceLineNo">054</span> // The client in 0.99+ does not ping the server.<a name="line.54"></a>
	<span class="sourceLineNo">055</span> int PING_CALL_ID = -1;<a name="line.55"></a>
	<span class="sourceLineNo">056</span><a name="line.56"></a>
	<span class="sourceLineNo">057</span> /**<a name="line.57"></a>
	<span class="sourceLineNo">058</span> * Creates a "channel" that can be used by a blocking protobuf service. Useful setting up protobuf<a name="line.58"></a>
	<span class="sourceLineNo">059</span> * blocking stubs.<a name="line.59"></a>
	<span class="sourceLineNo">060</span> * @param sn server name describing location of server<a name="line.60"></a>
	<span class="sourceLineNo">061</span> * @param user which is to use the connection<a name="line.61"></a>
	<span class="sourceLineNo">062</span> * @param rpcTimeout default rpc operation timeout<a name="line.62"></a>
	<span class="sourceLineNo">063</span> * @return A blocking rpc channel that goes via this rpc client instance.<a name="line.63"></a>
	<span class="sourceLineNo">064</span> */<a name="line.64"></a>
	<span class="sourceLineNo">065</span> BlockingRpcChannel createBlockingRpcChannel(ServerName sn, User user, int rpcTimeout);<a name="line.65"></a>
	<span class="sourceLineNo">066</span><a name="line.66"></a>
	<span class="sourceLineNo">067</span> /**<a name="line.67"></a>
	<span class="sourceLineNo">068</span> * Creates a "channel" that can be used by a protobuf service. Useful setting up protobuf stubs.<a name="line.68"></a>
	<span class="sourceLineNo">069</span> * @param sn server name describing location of server<a name="line.69"></a>
	<span class="sourceLineNo">070</span> * @param user which is to use the connection<a name="line.70"></a>
	<span class="sourceLineNo">071</span> * @param rpcTimeout default rpc operation timeout<a name="line.71"></a>
	<span class="sourceLineNo">072</span> * @return A rpc channel that goes via this rpc client instance.<a name="line.72"></a>
	<span class="sourceLineNo">073</span> */<a name="line.73"></a>
	<span class="sourceLineNo">074</span> RpcChannel createRpcChannel(final ServerName sn, final User user, int rpcTimeout);<a name="line.74"></a>
	<span class="sourceLineNo">075</span><a name="line.75"></a>
	<span class="sourceLineNo">076</span> /**<a name="line.76"></a>
	<span class="sourceLineNo">077</span> * Interrupt the connections to the given server. This should be called if the server is known as<a name="line.77"></a>
	<span class="sourceLineNo">078</span> * actually dead. This will not prevent current operation to be retried, and, depending on their<a name="line.78"></a>
	<span class="sourceLineNo">079</span> * own behavior, they may retry on the same server. This can be a feature, for example at startup.<a name="line.79"></a>
	<span class="sourceLineNo">080</span> * In any case, they're likely to get connection refused (if the process died) or no route to<a name="line.80"></a>
	<span class="sourceLineNo">081</span> * host: i.e. their next retries should be faster and with a safe exception.<a name="line.81"></a>
	<span class="sourceLineNo">082</span> * @param sn server location to cancel connections of<a name="line.82"></a>
	<span class="sourceLineNo">083</span> */<a name="line.83"></a>
	<span class="sourceLineNo">084</span> void cancelConnections(ServerName sn);<a name="line.84"></a>
	<span class="sourceLineNo">085</span><a name="line.85"></a>
	<span class="sourceLineNo">086</span> /**<a name="line.86"></a>
	<span class="sourceLineNo">087</span> * Stop all threads related to this client. No further calls may be made using this client.<a name="line.87"></a>
	<span class="sourceLineNo">088</span> */<a name="line.88"></a>
	<span class="sourceLineNo">089</span> @Override<a name="line.89"></a>
	<span class="sourceLineNo">090</span> void close();<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> * Return true when this client uses a {@link org.apache.hadoop.hbase.codec.Codec} and so supports<a name="line.93"></a>
	<span class="sourceLineNo">094</span> * cell blocks.<a name="line.94"></a>
	<span class="sourceLineNo">095</span> */<a name="line.95"></a>
	<span class="sourceLineNo">096</span> boolean hasCellBlockSupport();<a name="line.96"></a>
	<span class="sourceLineNo">097</span>}<a name="line.97"></a>




























































	</pre>
	</div>
	</body>
	</html>