org.apache.hadoop.hbase.ipc

Class AbstractRpcClient

java.lang.Object

org.apache.hadoop.hbase.ipc.AbstractRpcClient

Direct Known Subclasses:

AsyncRpcClient

@InterfaceAudience.Private
public abstract class AbstractRpcClient
extends java.lang.Object

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 java.lang.String	clusterId
protected org.apache.hadoop.hbase.codec.Codec	codec
protected org.apache.hadoop.io.compress.CompressionCodec	compressor
protected org.apache.hadoop.conf.Configuration	conf
protected int	connectTO
static java.lang.String	DEFAULT_CODEC_CLASS
static int	DEFAULT_SOCKET_TIMEOUT_CONNECT
static int	DEFAULT_SOCKET_TIMEOUT_READ
static int	DEFAULT_SOCKET_TIMEOUT_WRITE
protected long	failureSleep
protected boolean	fallbackAllowed
static java.lang.String	IDLE_TIME
protected org.apache.hadoop.hbase.ipc.IPCUtil	ipcUtil
protected java.net.SocketAddress	localAddr
static org.apache.commons.logging.Log	LOG
protected int	maxRetries
protected int	minIdleTimeBeforeClose
protected int	readTO
static java.lang.String	SOCKET_TIMEOUT_CONNECT
static java.lang.String	SOCKET_TIMEOUT_READ How long we wait when we wait for an answer.
static java.lang.String	SOCKET_TIMEOUT_WRITE
protected boolean	tcpKeepAlive
protected boolean	tcpNoDelay
protected org.apache.hadoop.hbase.security.UserProvider	userProvider
protected int	writeTO

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract org.apache.hadoop.hbase.util.Pair<com.google.protobuf.Message,org.apache.hadoop.hbase.CellScanner>	call(AsyncPayloadCarryingRpcController pcrc, com.google.protobuf.Descriptors.MethodDescriptor md, com.google.protobuf.Message param, com.google.protobuf.Message returnType, org.apache.hadoop.hbase.security.User ticket, java.net.InetSocketAddress isa) 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(org.apache.hadoop.hbase.ServerName sn, org.apache.hadoop.hbase.security.User ticket, int defaultOperationTimeout)
static java.lang.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 org.apache.hadoop.hbase.util.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.

Methods inherited from class java.lang.Object

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

Field Detail

IDLE_TIME

public static final java.lang.String IDLE_TIME

See Also:

Constant Field Values

DEFAULT_CODEC_CLASS

public static final java.lang.String DEFAULT_CODEC_CLASS

See Also:

Constant Field Values

SOCKET_TIMEOUT_CONNECT

public static final java.lang.String SOCKET_TIMEOUT_CONNECT

See Also:

Constant Field Values

SOCKET_TIMEOUT_READ

public static final java.lang.String SOCKET_TIMEOUT_READ

How long we wait when we wait for an answer. It's not the operation time, it's the time we wait when we start to receive an answer, when the remote write starts to send the data.

See Also:

Constant Field Values

SOCKET_TIMEOUT_WRITE

public static final java.lang.String SOCKET_TIMEOUT_WRITE

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT_CONNECT

public static final int DEFAULT_SOCKET_TIMEOUT_CONNECT

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT_READ

public static final int DEFAULT_SOCKET_TIMEOUT_READ

See Also:

Constant Field Values

DEFAULT_SOCKET_TIMEOUT_WRITE

public static final int DEFAULT_SOCKET_TIMEOUT_WRITE

See Also:

Constant Field Values

LOG

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

conf

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

clusterId

protected java.lang.String clusterId

localAddr

protected final java.net.SocketAddress localAddr

userProvider

protected org.apache.hadoop.hbase.security.UserProvider userProvider

ipcUtil

protected final org.apache.hadoop.hbase.ipc.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 org.apache.hadoop.hbase.codec.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,
                 java.lang.String clusterId,
                 java.net.SocketAddress localAddr)

Construct an IPC client for the cluster clusterId

Parameters:

conf - configuration

clusterId - the cluster id

localAddr - client socket bind address.

Method Detail

getDefaultCodec

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

getPoolType

protected static org.apache.hadoop.hbase.util.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 org.apache.hadoop.hbase.util.Pair<com.google.protobuf.Message,org.apache.hadoop.hbase.CellScanner> call(AsyncPayloadCarryingRpcController pcrc,
                                                                                                      com.google.protobuf.Descriptors.MethodDescriptor md,
                                                                                                      com.google.protobuf.Message param,
                                                                                                      com.google.protobuf.Message returnType,
                                                                                                      org.apache.hadoop.hbase.security.User ticket,
                                                                                                      java.net.InetSocketAddress isa)
                                                                                                                    throws java.io.IOException,
                                                                                                                           java.lang.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:

java.lang.InterruptedException

java.io.IOException

createBlockingRpcChannel

public com.google.protobuf.BlockingRpcChannel createBlockingRpcChannel(org.apache.hadoop.hbase.ServerName sn,
                                                              org.apache.hadoop.hbase.security.User ticket,
                                                              int defaultOperationTimeout)