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