org.apache.hadoop.hbase.ipc

Class RpcClientImpl

java.lang.Object

org.apache.hadoop.hbase.ipc.AbstractRpcClient

org.apache.hadoop.hbase.ipc.RpcClientImpl

All Implemented Interfaces:

Closeable, AutoCloseable, RpcClient

Direct Known Subclasses:

TestClientTimeouts.RandomTimeoutRpcClient

@InterfaceAudience.Private
public class RpcClientImpl
extends AbstractRpcClient

Does RPC against a cluster. Manages connections per regionserver in the cluster.

See HBaseServer

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	RpcClientImpl.Connection Thread that reads responses and notifies callers.

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.ipc.AbstractRpcClient

AbstractRpcClient.BlockingRpcChannelImplementation

Field Summary

Fields

Modifier and Type	Field and Description
protected AtomicInteger	callIdCnt
protected PoolMap<ConnectionId,RpcClientImpl.Connection>	connections
protected FailedServers	failedServers
protected AtomicBoolean	running
protected SocketFactory	socketFactory
protected static Map<AuthenticationProtos.TokenIdentifier.Kind,<any>>	tokenHandlers

Fields inherited from class org.apache.hadoop.hbase.ipc.AbstractRpcClient

clusterId, codec, compressor, conf, connectTO, failureSleep, fallbackAllowed, ipcUtil, localAddr, LOG, maxRetries, minIdleTimeBeforeClose, readTO, tcpKeepAlive, tcpNoDelay, userProvider, 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
RpcClientImpl(Configuration conf, String clusterId) Construct an IPC client for the cluster clusterId with the default SocketFactory
RpcClientImpl(Configuration conf, String clusterId, SocketAddress localAddr) Construct an IPC client for the cluster clusterId with the default SocketFactory This method is called with reflection by the RpcClientFactory to create an instance

Method Summary

Modifier and Type	Method and Description
protected Pair<Message,CellScanner>	call(PayloadCarryingRpcController pcrc, MethodDescriptor md, Message param, Message returnType, User ticket, InetSocketAddress addr) 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.
void	cancelConnections(ServerName sn) Interrupt the connections to the given ip:port server.
void	close() Stop all threads related to this client.
protected RpcClientImpl.Connection	createConnection(ConnectionId remoteId, Codec codec, CompressionCodec compressor) Creates a connection.
protected RpcClientImpl.Connection	getConnection(User ticket, Call call, InetSocketAddress addr) Get a connection from the pool, or create a new one and add it to the pool.
protected IOException	wrapException(InetSocketAddress addr, IOException exception) Take an IOException and the address we were trying to connect to and return an IOException with the input exception as the cause.

Methods inherited from class org.apache.hadoop.hbase.ipc.AbstractRpcClient

createBlockingRpcChannel, getDefaultCodec, getPoolSize, getPoolType

Methods inherited from class java.lang.Object

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

Field Detail

callIdCnt

protected final AtomicInteger callIdCnt

connections

protected final PoolMap<ConnectionId,RpcClientImpl.Connection> connections

running

protected final AtomicBoolean running

failedServers

protected final FailedServers failedServers

socketFactory

protected final SocketFactory socketFactory

tokenHandlers

protected static final Map<AuthenticationProtos.TokenIdentifier.Kind,<any>> tokenHandlers

Constructor Detail

RpcClientImpl

public RpcClientImpl(Configuration conf,
                     String clusterId)

Construct an IPC client for the cluster clusterId with the default SocketFactory

Parameters:

conf - configuration

clusterId - the cluster id

RpcClientImpl

public RpcClientImpl(Configuration conf,
                     String clusterId,
                     SocketAddress localAddr)

Construct an IPC client for the cluster clusterId with the default SocketFactory This method is called with reflection by the RpcClientFactory to create an instance

Parameters:

conf - configuration

clusterId - the cluster id

localAddr - client socket bind address.

Method Detail

createConnection

protected RpcClientImpl.Connection createConnection(ConnectionId remoteId,
                                                    Codec codec,
                                                    CompressionCodec compressor)
                                             throws IOException

Creates a connection. Can be overridden by a subclass for testing.

Parameters:

remoteId - - the ConnectionId to use for the connection creation.

Throws:

IOException

close

public void close()

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

call

protected Pair<Message,CellScanner> call(PayloadCarryingRpcController pcrc,
                                         MethodDescriptor md,
                                         Message param,
                                         Message returnType,
                                         User ticket,
                                         InetSocketAddress addr)
                                  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.

Specified by:

call in class AbstractRpcClient

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

wrapException

protected IOException wrapException(InetSocketAddress addr,
                                    IOException exception)

Take an IOException 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

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.

Parameters:

sn - server location to cancel connections of

getConnection

protected RpcClientImpl.Connection getConnection(User ticket,
                                                 Call call,
                                                 InetSocketAddress addr)
                                          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