org.apache.hadoop.hbase.ipc

Class AsyncRpcClient

java.lang.Object

org.apache.hadoop.hbase.ipc.AbstractRpcClient

org.apache.hadoop.hbase.ipc.AsyncRpcClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, RpcClient

@InterfaceAudience.LimitedPrivate(value="Configuration")
public class AsyncRpcClient
extends AbstractRpcClient

Netty client for the requests and responses

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsyncRpcClient.RpcChannelImplementation Blocking rpc channel that goes via hbase rpc.

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

AbstractRpcClient.BlockingRpcChannelImplementation

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.atomic.AtomicInteger	callIdCnt
static java.lang.String	CLIENT_MAX_THREADS
static java.lang.String	USE_GLOBAL_EVENT_LOOP_GROUP
static java.lang.String	USE_NATIVE_TRANSPORT

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
AsyncRpcClient(Configuration configuration, java.lang.String clusterId, java.net.SocketAddress localAddress) Constructor

Method Summary

Modifier and Type	Method and Description
java.nio.ByteBuffer	buildCellBlock(CellScanner cells) Build cell block
protected Pair<Message,CellScanner>	call(PayloadCarryingRpcController pcrc, Descriptors.MethodDescriptor md, Message param, Message returnType, User ticket, java.net.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() Close netty
CellScanner	createCellScanner(byte[] cellBlock) Create a cell scanner
RpcChannel	createRpcChannel(ServerName sn, User user, int rpcTimeout) Creates a "channel" that can be used by a protobuf service.
void	removeConnection(AsyncRpcChannel connection) Remove connection from pool

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

createBlockingRpcChannel, getDefaultCodec, getPoolSize, getPoolType, hasCellBlockSupport

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_MAX_THREADS

public static final java.lang.String CLIENT_MAX_THREADS

See Also:

Constant Field Values

USE_NATIVE_TRANSPORT

public static final java.lang.String USE_NATIVE_TRANSPORT

See Also:

Constant Field Values

USE_GLOBAL_EVENT_LOOP_GROUP

public static final java.lang.String USE_GLOBAL_EVENT_LOOP_GROUP

See Also:

Constant Field Values

callIdCnt

protected final java.util.concurrent.atomic.AtomicInteger callIdCnt

Constructor Detail

AsyncRpcClient

public AsyncRpcClient(Configuration configuration,
                      java.lang.String clusterId,
                      java.net.SocketAddress localAddress)

Constructor

Parameters:

configuration - to HBase

clusterId - for the cluster

localAddress - local address to connect to

Method Detail

call

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

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:

java.lang.InterruptedException - if call is interrupted

java.io.IOException - if a connection failure is encountered

close

public void close()

Close netty

createCellScanner

public CellScanner createCellScanner(byte[] cellBlock)
                              throws java.io.IOException

Create a cell scanner

Parameters:

cellBlock - to create scanner for

Returns:

CellScanner

Throws:

java.io.IOException - on error on creation cell scanner

buildCellBlock

public java.nio.ByteBuffer buildCellBlock(CellScanner cells)
                                   throws java.io.IOException

Build cell block

Parameters:

cells - to create block with

Returns:

ByteBuffer with cells

Throws:

java.io.IOException - if block creation fails

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. there next retries should be faster and with a safe exception.

Parameters:

sn - server to cancel connections for

removeConnection

public void removeConnection(AsyncRpcChannel connection)

Remove connection from pool

createRpcChannel

public RpcChannel createRpcChannel(ServerName sn,
                                   User user,
                                   int rpcTimeout)

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

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:

java.io.IOException - when channel could not be created