1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 package org.apache.hadoop.hbase.ipc;
19
20 import com.google.protobuf.BlockingRpcChannel;
21 import com.google.protobuf.RpcChannel;
22
23 import java.io.Closeable;
24 import java.io.IOException;
25
26 import org.apache.hadoop.hbase.ServerName;
27 import org.apache.hadoop.hbase.classification.InterfaceAudience;
28 import org.apache.hadoop.hbase.security.User;
29
30 /**
31 * Interface for RpcClient implementations so ConnectionManager can handle it.
32 */
33 @InterfaceAudience.Private
34 public interface RpcClient extends Closeable {
35 String FAILED_SERVER_EXPIRY_KEY = "hbase.ipc.client.failed.servers.expiry";
36 int FAILED_SERVER_EXPIRY_DEFAULT = 2000;
37 String IDLE_TIME = "hbase.ipc.client.connection.minIdleTimeBeforeClose";
38 String IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY =
39 "hbase.ipc.client.fallback-to-simple-auth-allowed";
40 boolean IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT = false;
41 String SPECIFIC_WRITE_THREAD = "hbase.ipc.client.specificThreadForWriting";
42 String DEFAULT_CODEC_CLASS = "hbase.client.default.rpc.codec";
43
44 String SOCKET_TIMEOUT_CONNECT = "hbase.ipc.client.socket.timeout.connect";
45 /**
46 * How long we wait when we wait for an answer. It's not the operation time, it's the time
47 * we wait when we start to receive an answer, when the remote write starts to send the data.
48 */
49 String SOCKET_TIMEOUT_READ = "hbase.ipc.client.socket.timeout.read";
50 String SOCKET_TIMEOUT_WRITE = "hbase.ipc.client.socket.timeout.write";
51 int DEFAULT_SOCKET_TIMEOUT_CONNECT = 10000; // 10 seconds
52 int DEFAULT_SOCKET_TIMEOUT_READ = 20000; // 20 seconds
53 int DEFAULT_SOCKET_TIMEOUT_WRITE = 60000; // 60 seconds
54
55 // Used by the server, for compatibility with old clients.
56 // The client in 0.99+ does not ping the server.
57 int PING_CALL_ID = -1;
58
59 /**
60 * Creates a "channel" that can be used by a blocking protobuf service. Useful setting up
61 * protobuf blocking stubs.
62 *
63 * @param sn server name describing location of server
64 * @param user which is to use the connection
65 * @param rpcTimeout default rpc operation timeout
66 *
67 * @return A blocking rpc channel that goes via this rpc client instance.
68 * @throws IOException when channel could not be created
69 */
70 BlockingRpcChannel createBlockingRpcChannel(ServerName sn, User user, int rpcTimeout)
71 throws IOException;
72
73 /**
74 * Creates a "channel" that can be used by a protobuf service. Useful setting up
75 * protobuf stubs.
76 *
77 * @param sn server name describing location of server
78 * @param user which is to use the connection
79 * @param rpcTimeout default rpc operation timeout
80 *
81 * @return A rpc channel that goes via this rpc client instance.
82 */
83 RpcChannel createRpcChannel(final ServerName sn, final User user, int rpcTimeout)
84 throws IOException;
85
86 /**
87 * Interrupt the connections to the given server. This should be called if the server
88 * is known as actually dead. This will not prevent current operation to be retried, and,
89 * depending on their own behavior, they may retry on the same server. This can be a feature,
90 * for example at startup. In any case, they're likely to get connection refused (if the
91 * process died) or no route to host: i.e. their next retries should be faster and with a
92 * safe exception.
93 * @param sn server location to cancel connections of
94 */
95 void cancelConnections(ServerName sn);
96
97 /**
98 * Stop all threads related to this client. No further calls may be made
99 * using this client.
100 */
101 @Override
102 void close();
103
104 /**
105 * @return true when this client uses a {@link org.apache.hadoop.hbase.codec.Codec} and so
106 * supports cell blocks.
107 */
108 boolean hasCellBlockSupport();
109 }