AbstractRpcClient (Apache HBase 1.4.11 API)

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 org.apache.hadoop.hbase.ipc.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.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`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
`protected org.apache.hadoop.hbase.ipc.CellBlockBuilder`	`cellBlockBuilder`
`protected String`	`clusterId`
`protected Codec`	`codec`
`protected org.apache.hadoop.io.compress.CompressionCodec`	`compressor`
`protected org.apache.hadoop.conf.Configuration`	`conf`
`protected PoolMap<ConnectionId,T>`	`connections`
`protected int`	`connectTO`
`protected FailedServers`	`failedServers`
`protected long`	`failureSleep`
`protected boolean`	`fallbackAllowed`
`protected SocketAddress`	`localAddr`
`static org.apache.commons.logging.Log`	`LOG`
`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 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

Methods
Modifier and Type	Method and Description
`void`	`cancelConnections(ServerName sn)` Interrupt the connections to the given ip:port server.
`void`	`close()` Stop all threads related to this client.
`protected abstract void`	`closeInternal()`
`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.
`com.google.protobuf.RpcChannel`	`createRpcChannel(ServerName sn, User user, int rpcTimeout)` Creates a "channel" that can be used by a protobuf service.
`static String`	`getDefaultCodec(org.apache.hadoop.conf.Configuration c)`
`boolean`	`hasCellBlockSupport()`

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.apache.commons.logging.Log LOG

WHEEL_TIMER

protected static final io.netty.util.HashedWheelTimer WHEEL_TIMER

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 org.apache.hadoop.hbase.ipc.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 org.apache.hadoop.hbase.ipc.RpcConnection> connections

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.
- createConnection
```
protected abstract T createConnection(ConnectionId remoteId)
                                                                                 throws IOException
```
  Not connected.
  
  Throws:
  
  IOException
- 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
- 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 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 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

Class AbstractRpcClient<T extends org.apache.hadoop.hbase.ipc.RpcConnection>

Nested Class Summary

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

WHEEL_TIMER

TOKEN_HANDLERS

running

conf

clusterId

localAddr

metrics

userProvider

cellBlockBuilder

minIdleTimeBeforeClose

maxRetries

failureSleep

tcpNoDelay

tcpKeepAlive

codec

compressor

fallbackAllowed

failedServers

connectTO

readTO

writeTO

connections

Constructor Detail

AbstractRpcClient

Method Detail

getDefaultCodec

hasCellBlockSupport

createConnection

cancelConnections

closeInternal

close

createBlockingRpcChannel

createRpcChannel