001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.ipc;
019
020import java.io.Closeable;
021import java.io.IOException;
022import org.apache.hadoop.hbase.ServerName;
023import org.apache.hadoop.hbase.security.User;
024import org.apache.yetus.audience.InterfaceAudience;
025
026import org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel;
027import org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel;
028
029/**
030 * Interface for RpcClient implementations so ConnectionManager can handle it.
031 */
032@InterfaceAudience.Private
033public interface RpcClient extends Closeable {
034  String FAILED_SERVER_EXPIRY_KEY = "hbase.ipc.client.failed.servers.expiry";
035  int FAILED_SERVER_EXPIRY_DEFAULT = 2000;
036  String IDLE_TIME = "hbase.ipc.client.connection.minIdleTimeBeforeClose";
037  String IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY =
038      "hbase.ipc.client.fallback-to-simple-auth-allowed";
039  boolean IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT = false;
040  String SPECIFIC_WRITE_THREAD = "hbase.ipc.client.specificThreadForWriting";
041  String DEFAULT_CODEC_CLASS = "hbase.client.default.rpc.codec";
042
043  String SOCKET_TIMEOUT_CONNECT = "hbase.ipc.client.socket.timeout.connect";
044  /**
045   * How long we wait when we wait for an answer. It's not the operation time, it's the time
046   * we wait when we start to receive an answer, when the remote write starts to send the data.
047   */
048  String SOCKET_TIMEOUT_READ = "hbase.ipc.client.socket.timeout.read";
049  String SOCKET_TIMEOUT_WRITE = "hbase.ipc.client.socket.timeout.write";
050  int DEFAULT_SOCKET_TIMEOUT_CONNECT = 10000; // 10 seconds
051  int DEFAULT_SOCKET_TIMEOUT_READ = 20000; // 20 seconds
052  int DEFAULT_SOCKET_TIMEOUT_WRITE = 60000; // 60 seconds
053
054  // Used by the server, for compatibility with old clients.
055  // The client in 0.99+ does not ping the server.
056  int PING_CALL_ID = -1;
057
058  /**
059   * Creates a "channel" that can be used by a blocking protobuf service.  Useful setting up
060   * protobuf blocking stubs.
061   *
062   * @param sn server name describing location of server
063   * @param user which is to use the connection
064   * @param rpcTimeout default rpc operation timeout
065   *
066   * @return A blocking rpc channel that goes via this rpc client instance.
067   * @throws IOException when channel could not be created
068   */
069  BlockingRpcChannel createBlockingRpcChannel(ServerName sn, User user, int rpcTimeout)
070      throws IOException;
071
072  /**
073   * Creates a "channel" that can be used by a protobuf service.  Useful setting up
074   * protobuf stubs.
075   *
076   * @param sn server name describing location of server
077   * @param user which is to use the connection
078   * @param rpcTimeout default rpc operation timeout
079   *
080   * @return A rpc channel that goes via this rpc client instance.
081   */
082  RpcChannel createRpcChannel(final ServerName sn, final User user, int rpcTimeout)
083      throws IOException;
084
085  /**
086   * Interrupt the connections to the given server. This should be called if the server
087   * is known as actually dead. This will not prevent current operation to be retried, and,
088   * depending on their own behavior, they may retry on the same server. This can be a feature,
089   * for example at startup. In any case, they're likely to get connection refused (if the
090   * process died) or no route to host: i.e. their next retries should be faster and with a
091   * safe exception.
092   * @param sn server location to cancel connections of
093   */
094  void cancelConnections(ServerName sn);
095
096  /**
097   * Stop all threads related to this client.  No further calls may be made
098   * using this client.
099   */
100  @Override
101  void close();
102
103  /**
104   * @return true when this client uses a {@link org.apache.hadoop.hbase.codec.Codec} and so
105   *         supports cell blocks.
106   */
107  boolean hasCellBlockSupport();
108}