org.apache.hadoop.hbase.ipc

Class AbstractRpcClient<T extends RpcConnection>

java.lang.Object

org.apache.hadoop.hbase.ipc.AbstractRpcClient<T>

All Implemented Interfaces:

Closeable, AutoCloseable, RpcClient

Direct Known Subclasses:

BlockingRpcClient, NettyRpcClient

@InterfaceAudience.Private
public abstract class AbstractRpcClient<T extends RpcConnection>
extends Object
implements RpcClient

Provides the basics for a RpcClient implementation like configuration and Logging.

Locking schema of the current IPC implementation

• There is a lock in AbstractRpcClient to protect the fetching or creating connection.
• There is a lock in Call to make sure that we can only finish the call once.
• The same for HBaseRpcController as Call. And see the comment of HBaseRpcController.notifyOnCancel(RpcCallback, HBaseRpcController.CancellationCallback) of how to deal with cancel.
• For connection implementation, the construction of a connection should be as fast as possible because the creation is protected under a lock. Connect to remote side when needed. There is no forced locking schema for a connection implementation.
• For the locking order, the Call and HBaseRpcController's lock should be held at last. So the callbacks in Call and HBaseRpcController should be execute outside the lock in Call and HBaseRpcController which means the implementations of the callbacks are free to hold any lock.

Since:

2.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractRpcClient.AbstractRpcChannel
static class	AbstractRpcClient.BlockingRpcChannelImplementation Blocking rpc channel that goes via hbase rpc.
static class	AbstractRpcClient.RpcChannelImplementation Async rpc channel that goes via hbase rpc.

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicInteger	callIdCnt
protected CellBlockBuilder	cellBlockBuilder
private ScheduledFuture<?>	cleanupIdleConnectionTask
protected String	clusterId
protected Codec	codec
protected org.apache.hadoop.io.compress.CompressionCodec	compressor
private static org.apache.hbase.thirdparty.com.google.common.cache.LoadingCache<InetSocketAddress,AtomicInteger>	concurrentCounterCache
protected org.apache.hadoop.conf.Configuration	conf
protected PoolMap<ConnectionId,T>	connections
protected int	connectTO
protected FailedServers	failedServers
protected long	failureSleep
protected boolean	fallbackAllowed
private static ScheduledExecutorService	IDLE_CONN_SWEEPER
protected SocketAddress	localAddr
static org.slf4j.Logger	LOG
private int	maxConcurrentCallsPerServer
protected int	maxRetries
protected MetricsConnection	metrics
protected int	minIdleTimeBeforeClose
protected int	readTO
protected boolean	running
protected boolean	tcpKeepAlive
protected boolean	tcpNoDelay
protected static Map<org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.TokenIdentifier.Kind,org.apache.hadoop.security.token.TokenSelector<? extends org.apache.hadoop.security.token.TokenIdentifier>>	TOKEN_HANDLERS
protected UserProvider	userProvider
protected static org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer	WHEEL_TIMER
protected int	writeTO

Fields inherited from interface org.apache.hadoop.hbase.ipc.RpcClient

DEFAULT_CODEC_CLASS, DEFAULT_SOCKET_TIMEOUT_CONNECT, DEFAULT_SOCKET_TIMEOUT_READ, DEFAULT_SOCKET_TIMEOUT_WRITE, FAILED_SERVER_EXPIRY_DEFAULT, FAILED_SERVER_EXPIRY_KEY, IDLE_TIME, IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_DEFAULT, IPC_CLIENT_FALLBACK_TO_SIMPLE_AUTH_ALLOWED_KEY, PING_CALL_ID, SOCKET_TIMEOUT_CONNECT, SOCKET_TIMEOUT_READ, SOCKET_TIMEOUT_WRITE, SPECIFIC_WRITE_THREAD

Constructor Summary

Constructors

Constructor and Description
AbstractRpcClient(org.apache.hadoop.conf.Configuration conf, String clusterId, SocketAddress localAddr, MetricsConnection metrics) Construct an IPC client for the cluster clusterId

Method Summary

Modifier and Type	Method and Description
private org.apache.hbase.thirdparty.com.google.protobuf.Message	callBlockingMethod(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md, HBaseRpcController hrc, org.apache.hbase.thirdparty.com.google.protobuf.Message param, org.apache.hbase.thirdparty.com.google.protobuf.Message returnType, User ticket, InetSocketAddress isa) Make a blocking call.
private void	callMethod(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md, HBaseRpcController hrc, org.apache.hbase.thirdparty.com.google.protobuf.Message param, org.apache.hbase.thirdparty.com.google.protobuf.Message returnType, User ticket, InetSocketAddress addr, org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<org.apache.hbase.thirdparty.com.google.protobuf.Message> callback)
void	cancelConnections(ServerName sn) Interrupt the connections to the given ip:port server.
private void	cleanupIdleConnections()
void	close() Stop all threads related to this client.
protected abstract void	closeInternal()
(package private) static HBaseRpcController	configureHBaseRpcController(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller, int channelOperationTimeout) Configure an hbase rpccontroller
private InetSocketAddress	createAddr(ServerName sn)
org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel	createBlockingRpcChannel(ServerName sn, User ticket, int rpcTimeout) Creates a "channel" that can be used by a blocking protobuf service.
protected abstract T	createConnection(ConnectionId remoteId) Not connected.
org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel	createRpcChannel(ServerName sn, User user, int rpcTimeout) Creates a "channel" that can be used by a protobuf service.
(package private) Codec	getCodec() Encapsulate the ugly casting and RuntimeException conversion in private method.
private static org.apache.hadoop.io.compress.CompressionCodec	getCompressor(org.apache.hadoop.conf.Configuration conf) Encapsulate the ugly casting and RuntimeException conversion in private method.
private T	getConnection(ConnectionId remoteId) Get a connection from the pool, or create a new one and add it to the pool.
static String	getDefaultCodec(org.apache.hadoop.conf.Configuration c)
private static int	getPoolSize(org.apache.hadoop.conf.Configuration config) Return the pool size specified in the configuration, which is applicable only if the pool type is PoolMap.PoolType.RoundRobin.
private static PoolMap.PoolType	getPoolType(org.apache.hadoop.conf.Configuration config) Return the pool type specified in the configuration, which must be set to either PoolMap.PoolType.RoundRobin or PoolMap.PoolType.ThreadLocal, otherwise default to the former.
boolean	hasCellBlockSupport()
(package private) boolean	isTcpNoDelay()
private int	nextCallId()
private void	onCallFinished(Call call, HBaseRpcController hrc, InetSocketAddress addr, org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<org.apache.hbase.thirdparty.com.google.protobuf.Message> callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final org.slf4j.Logger LOG

WHEEL_TIMER

protected static final org.apache.hbase.thirdparty.io.netty.util.HashedWheelTimer WHEEL_TIMER

IDLE_CONN_SWEEPER

private static final ScheduledExecutorService IDLE_CONN_SWEEPER

TOKEN_HANDLERS

protected static final Map<org.apache.hadoop.hbase.protobuf.generated.AuthenticationProtos.TokenIdentifier.Kind,org.apache.hadoop.security.token.TokenSelector<? extends org.apache.hadoop.security.token.TokenIdentifier>> TOKEN_HANDLERS

running

protected boolean running

conf

protected final org.apache.hadoop.conf.Configuration conf

clusterId

protected final String clusterId

localAddr

protected final SocketAddress localAddr

metrics

protected final MetricsConnection metrics

userProvider

protected final UserProvider userProvider

cellBlockBuilder

protected final CellBlockBuilder cellBlockBuilder

minIdleTimeBeforeClose

protected final int minIdleTimeBeforeClose

maxRetries

protected final int maxRetries

failureSleep

protected final long failureSleep

tcpNoDelay

protected final boolean tcpNoDelay

tcpKeepAlive

protected final boolean tcpKeepAlive

codec

protected final Codec codec

compressor

protected final org.apache.hadoop.io.compress.CompressionCodec compressor

fallbackAllowed

protected final boolean fallbackAllowed

failedServers

protected final FailedServers failedServers

connectTO

protected final int connectTO

readTO

protected final int readTO

writeTO

protected final int writeTO

connections

protected final PoolMap<ConnectionId,T extends RpcConnection> connections

callIdCnt

private final AtomicInteger callIdCnt

cleanupIdleConnectionTask

private final ScheduledFuture<?> cleanupIdleConnectionTask

maxConcurrentCallsPerServer

private int maxConcurrentCallsPerServer

concurrentCounterCache

private static final org.apache.hbase.thirdparty.com.google.common.cache.LoadingCache<InetSocketAddress,AtomicInteger> concurrentCounterCache

Constructor Detail

AbstractRpcClient

public AbstractRpcClient(org.apache.hadoop.conf.Configuration conf,
                         String clusterId,
                         SocketAddress localAddr,
                         MetricsConnection metrics)

Construct an IPC client for the cluster clusterId

Parameters:

conf - configuration

clusterId - the cluster id

localAddr - client socket bind address.

metrics - the connection metrics

Method Detail

cleanupIdleConnections

private void cleanupIdleConnections()

getDefaultCodec

public static String getDefaultCodec(org.apache.hadoop.conf.Configuration c)

getCodec

Codec getCodec()

Encapsulate the ugly casting and RuntimeException conversion in private method.

Returns:

Codec to use on this client.

hasCellBlockSupport

public boolean hasCellBlockSupport()

Specified by:

hasCellBlockSupport in interface RpcClient

Returns:

true when this client uses a Codec and so supports cell blocks.

isTcpNoDelay

boolean isTcpNoDelay()

getCompressor

private static org.apache.hadoop.io.compress.CompressionCodec getCompressor(org.apache.hadoop.conf.Configuration conf)

Encapsulate the ugly casting and RuntimeException conversion in private method.

Parameters:

conf - configuration

Returns:

The compressor to use on this client.

getPoolType

private static PoolMap.PoolType getPoolType(org.apache.hadoop.conf.Configuration config)

Return the pool type specified in the configuration, which must be set to either PoolMap.PoolType.RoundRobin or PoolMap.PoolType.ThreadLocal, otherwise default to the former. For applications with many user threads, use a small round-robin pool. For applications with few user threads, you may want to try using a thread-local pool. In any case, the number of RpcClient instances should not exceed the operating system's hard limit on the number of connections.

Parameters:

config - configuration

Returns:

either a PoolMap.PoolType.RoundRobin or PoolMap.PoolType.ThreadLocal

getPoolSize

private static int getPoolSize(org.apache.hadoop.conf.Configuration config)

Return the pool size specified in the configuration, which is applicable only if the pool type is PoolMap.PoolType.RoundRobin.

Parameters:

config - configuration

Returns:

the maximum pool size

nextCallId

private int nextCallId()

callBlockingMethod

private org.apache.hbase.thirdparty.com.google.protobuf.Message callBlockingMethod(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md,
                                                                                   HBaseRpcController hrc,
                                                                                   org.apache.hbase.thirdparty.com.google.protobuf.Message param,
                                                                                   org.apache.hbase.thirdparty.com.google.protobuf.Message returnType,
                                                                                   User ticket,
                                                                                   InetSocketAddress isa)
                                                                            throws org.apache.hbase.thirdparty.com.google.protobuf.ServiceException

Make a blocking call. Throws exceptions if there are network problems or if the remote code threw an exception.

Parameters:

ticket - Be careful which ticket you pass. A new user will mean a new Connection. UserProvider.getCurrent() makes a new instance of User each time so will be a new Connection each time.

Returns:

A pair with the Message response and the Cell data (if any).

Throws:

org.apache.hbase.thirdparty.com.google.protobuf.ServiceException

getConnection

private T getConnection(ConnectionId remoteId)
                 throws IOException

Get a connection from the pool, or create a new one and add it to the pool. Connections to a given host/port are reused.

Throws:

IOException

createConnection

protected abstract T createConnection(ConnectionId remoteId)
                               throws IOException

Not connected.

Throws:

IOException

onCallFinished

private void onCallFinished(Call call,
                            HBaseRpcController hrc,
                            InetSocketAddress addr,
                            org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<org.apache.hbase.thirdparty.com.google.protobuf.Message> callback)

callMethod

private void callMethod(org.apache.hbase.thirdparty.com.google.protobuf.Descriptors.MethodDescriptor md,
                        HBaseRpcController hrc,
                        org.apache.hbase.thirdparty.com.google.protobuf.Message param,
                        org.apache.hbase.thirdparty.com.google.protobuf.Message returnType,
                        User ticket,
                        InetSocketAddress addr,
                        org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<org.apache.hbase.thirdparty.com.google.protobuf.Message> callback)

createAddr

private InetSocketAddress createAddr(ServerName sn)
                              throws UnknownHostException

Throws:

UnknownHostException

cancelConnections

public void cancelConnections(ServerName sn)

Interrupt the connections to the given ip:port server. This should be called if the server is known as actually dead. This will not prevent current operation to be retried, and, depending on their own behavior, they may retry on the same server. This can be a feature, for example at startup. In any case, they're likely to get connection refused (if the process died) or no route to host: i.e. their next retries should be faster and with a safe exception.

Specified by:

cancelConnections in interface RpcClient

Parameters:

sn - server location to cancel connections of

configureHBaseRpcController

static HBaseRpcController configureHBaseRpcController(org.apache.hbase.thirdparty.com.google.protobuf.RpcController controller,
                                                      int channelOperationTimeout)

Configure an hbase rpccontroller

Parameters:

controller - to configure

channelOperationTimeout - timeout for operation

Returns:

configured controller

closeInternal

protected abstract void closeInternal()

close

public void close()

Description copied from interface: RpcClient

Stop all threads related to this client. No further calls may be made using this client.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface RpcClient

createBlockingRpcChannel

public org.apache.hbase.thirdparty.com.google.protobuf.BlockingRpcChannel createBlockingRpcChannel(ServerName sn,
                                                                                                   User ticket,
                                                                                                   int rpcTimeout)
                                                                                            throws UnknownHostException

Description copied from interface: RpcClient

Creates a "channel" that can be used by a blocking protobuf service. Useful setting up protobuf blocking stubs.

Specified by:

createBlockingRpcChannel in interface RpcClient

Parameters:

sn - server name describing location of server

ticket - which is to use the connection

rpcTimeout - default rpc operation timeout

Returns:

A blocking rpc channel that goes via this rpc client instance.

Throws:

UnknownHostException

createRpcChannel

public org.apache.hbase.thirdparty.com.google.protobuf.RpcChannel createRpcChannel(ServerName sn,
                                                                                   User user,
                                                                                   int rpcTimeout)
                                                                            throws UnknownHostException

Description copied from interface: RpcClient

Creates a "channel" that can be used by a protobuf service. Useful setting up protobuf stubs.

Specified by:

createRpcChannel in interface RpcClient

Parameters:

sn - server name describing location of server

user - which is to use the connection

rpcTimeout - default rpc operation timeout

Returns:

A rpc channel that goes via this rpc client instance.

Throws:

UnknownHostException