org.apache.hadoop.hbase.ipc

Class AbstractRpcClient

java.lang.Object

org.apache.hadoop.hbase.ipc.AbstractRpcClient

All Implemented Interfaces:

Closeable, AutoCloseable, RpcClient

Direct Known Subclasses:

AsyncRpcClient, RpcClientImpl

@InterfaceAudience.Private
public abstract class AbstractRpcClient
extends Object
implements RpcClient

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

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected String	clusterId
protected Codec	codec
protected org.apache.hadoop.io.compress.CompressionCodec	compressor
protected org.apache.hadoop.conf.Configuration	conf
protected int	connectTO
protected long	failureSleep
protected boolean	fallbackAllowed
protected IPCUtil	ipcUtil
protected SocketAddress	localAddr
static org.apache.commons.logging.Log	LOG
protected int	maxRetries
protected MetricsConnection	metrics
protected int	minIdleTimeBeforeClose
protected int	readTO
protected boolean	tcpKeepAlive
protected boolean	tcpNoDelay
protected UserProvider	userProvider
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

Methods

Modifier and Type	Method and Description
protected abstract Pair<com.google.protobuf.Message,CellScanner>	call(PayloadCarryingRpcController pcrc, com.google.protobuf.Descriptors.MethodDescriptor md, com.google.protobuf.Message param, com.google.protobuf.Message returnType, User ticket, InetSocketAddress isa, MetricsConnection.CallStats callStats) Make a call, passing param, to the IPC server running at address which is servicing the protocol protocol, with the ticket credentials, returning the value.
com.google.protobuf.BlockingRpcChannel	createBlockingRpcChannel(ServerName sn, User ticket, int defaultOperationTimeout) Creates a "channel" that can be used by a blocking protobuf service.
static String	getDefaultCodec(org.apache.hadoop.conf.Configuration c)
protected 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.
protected 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()
protected IOException	wrapException(InetSocketAddress addr, Exception exception) Takes an Exception and the address we were trying to connect to and return an IOException with the input exception as the cause.

Methods inherited from class java.lang.Object

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

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

cancelConnections, close

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

conf

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

clusterId

protected String clusterId

localAddr

protected final SocketAddress localAddr

metrics

protected final MetricsConnection metrics

userProvider

protected UserProvider userProvider

ipcUtil

protected final IPCUtil ipcUtil

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

connectTO

protected final int connectTO

readTO

protected final int readTO

writeTO

protected final int writeTO

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

getDefaultCodec

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

hasCellBlockSupport

public boolean hasCellBlockSupport()

Specified by:

hasCellBlockSupport in interface RpcClient

Returns:

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

getPoolType

protected 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

protected 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

call

protected abstract Pair<com.google.protobuf.Message,CellScanner> call(PayloadCarryingRpcController pcrc,
                                                 com.google.protobuf.Descriptors.MethodDescriptor md,
                                                 com.google.protobuf.Message param,
                                                 com.google.protobuf.Message returnType,
                                                 User ticket,
                                                 InetSocketAddress isa,
                                                 MetricsConnection.CallStats callStats)
                                                               throws IOException,
                                                                      InterruptedException

Make a call, passing param, to the IPC server running at address which is servicing the protocol protocol, with the ticket credentials, returning the value. 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:

InterruptedException

IOException

createBlockingRpcChannel

public com.google.protobuf.BlockingRpcChannel createBlockingRpcChannel(ServerName sn,
                                                              User ticket,
                                                              int defaultOperationTimeout)
                                                                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

defaultOperationTimeout - default rpc operation timeout

Returns:

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

Throws:

UnknownHostException

wrapException

protected IOException wrapException(InetSocketAddress addr,
                        Exception exception)

Takes an Exception and the address we were trying to connect to and return an IOException with the input exception as the cause. The new exception provides the stack trace of the place where the exception is thrown and some extra diagnostics information. If the exception is ConnectException or SocketTimeoutException, return a new one of the same type; Otherwise return an IOException.

Parameters:

addr - target address

exception - the relevant exception

Returns:

an exception to throw