hbase-client/src/main/java/org/apache/hadoop/hbase/ipc/RpcClient.java

   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 java.io.Closeable;
  21 import org.apache.hadoop.hbase.ServerName;
  22 import org.apache.hadoop.hbase.security.User;
  23 import org.apache.yetus.audience.InterfaceAudience;
  24
  25 import org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel;
  26 import org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel;
  27
  28 /**
  29  * Interface for RpcClient implementations so ConnectionManager can handle it.
  30  */
  31 @InterfaceAudience.Private
  32 public interface RpcClient extends Closeable {
  33   String FAILED_SERVER_EXPIRY_KEY = "hbase.ipc.client.failed.servers.expiry";
  34   int FAILED_SERVER_EXPIRY_DEFAULT = 2000;
  35   String IDLE_TIME = "hbase.ipc.client.connection.minIdleTimeBeforeClose";
  36   String IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY =
  37       "hbase.ipc.client.fallback-to-simple-auth-allowed";
  38   boolean IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT = false;
  39   String SPECIFIC_WRITE_THREAD = "hbase.ipc.client.specificThreadForWriting";
  40   String DEFAULT_CODEC_CLASS = "hbase.client.default.rpc.codec";
  41
  42   String SOCKET_TIMEOUT_CONNECT = "hbase.ipc.client.socket.timeout.connect";
  43   /**
  44    * How long we wait when we wait for an answer. It's not the operation time, it's the time
  45    * we wait when we start to receive an answer, when the remote write starts to send the data.
  46    */
  47   String SOCKET_TIMEOUT_READ = "hbase.ipc.client.socket.timeout.read";
  48   String SOCKET_TIMEOUT_WRITE = "hbase.ipc.client.socket.timeout.write";
  49   int DEFAULT_SOCKET_TIMEOUT_CONNECT = 10000; // 10 seconds
  50   int DEFAULT_SOCKET_TIMEOUT_READ = 20000; // 20 seconds
  51   int DEFAULT_SOCKET_TIMEOUT_WRITE = 60000; // 60 seconds
  52
  53   // Used by the server, for compatibility with old clients.
  54   // The client in 0.99+ does not ping the server.
  55   int PING_CALL_ID = -1;
  56
  57   /**
  58    * Creates a "channel" that can be used by a blocking protobuf service.  Useful setting up
  59    * protobuf blocking stubs.
  60    *
  61    * @param sn server name describing location of server
  62    * @param user which is to use the connection
  63    * @param rpcTimeout default rpc operation timeout
  64    *
  65    * @return A blocking rpc channel that goes via this rpc client instance.
  66    */
  67   BlockingRpcChannel createBlockingRpcChannel(ServerName sn, User user, int rpcTimeout);
  68
  69   /**
  70    * Creates a "channel" that can be used by a protobuf service.  Useful setting up
  71    * protobuf stubs.
  72    *
  73    * @param sn server name describing location of server
  74    * @param user which is to use the connection
  75    * @param rpcTimeout default rpc operation timeout
  76    *
  77    * @return A rpc channel that goes via this rpc client instance.
  78    */
  79   RpcChannel createRpcChannel(final ServerName sn, final User user, int rpcTimeout);
  80
  81   /**
  82    * Interrupt the connections to the given server. This should be called if the server
  83    * is known as actually dead. This will not prevent current operation to be retried, and,
  84    * depending on their own behavior, they may retry on the same server. This can be a feature,
  85    * for example at startup. In any case, they're likely to get connection refused (if the
  86    * process died) or no route to host: i.e. their next retries should be faster and with a
  87    * safe exception.
  88    * @param sn server location to cancel connections of
  89    */
  90   void cancelConnections(ServerName sn);
  91
  92   /**
  93    * Stop all threads related to this client.  No further calls may be made
  94    * using this client.
  95    */
  96   @Override
  97   void close();
  98
  99   /**
 100    * @return true when this client uses a {@link org.apache.hadoop.hbase.codec.Codec} and so
 101    *         supports cell blocks.
 102    */
 103   boolean hasCellBlockSupport();
 104 }