org.apache.hadoop.hbase.client

Class AbstractRpcBasedConnectionRegistry

java.lang.Object

org.apache.hadoop.hbase.client.AbstractRpcBasedConnectionRegistry

All Implemented Interfaces:

Closeable, AutoCloseable, ConnectionRegistry

Direct Known Subclasses:

MasterRegistry, RpcConnectionRegistry

@InterfaceAudience.Private
abstract class AbstractRpcBasedConnectionRegistry
extends Object
implements ConnectionRegistry

Base class for rpc based connection registry implementation.

The implementation needs a bootstrap node list in configuration, and then it will use the methods in RegistryProtos.ClientMetaService to refresh the connection registry end points.

It also supports hedged reads, the default fan out value is 2.

For the actual configuration names, see javadoc of sub classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	AbstractRpcBasedConnectionRegistry.Callable<T> For describing the actual asynchronous rpc call.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap<ServerName,org.apache.hadoop.hbase.shaded.protobuf.generated.RegistryProtos.ClientMetaService.Interface>	addr2Stub
static int	HEDGED_REQS_FANOUT_DEFAULT Default value for the fan out of hedged requests.
private int	hedgedReadFanOut
private RegistryEndpointsRefresher	registryEndpointRefresher
private RpcClient	rpcClient
private RpcControllerFactory	rpcControllerFactory
private int	rpcTimeoutMs

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractRpcBasedConnectionRegistry(org.apache.hadoop.conf.Configuration conf, String hedgedReqsFanoutConfigName, String initialRefreshDelaySecsConfigName, String refreshIntervalSecsConfigName, String minRefreshIntervalSecsConfigName)

Method Summary

Modifier and Type	Method and Description
private IOException	badResponse(String debug)
protected <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> CompletableFuture<T>	call(AbstractRpcBasedConnectionRegistry.Callable<T> callable, Predicate<T> isValidResp, String debug)
private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> CompletableFuture<T>	call(org.apache.hadoop.hbase.shaded.protobuf.generated.RegistryProtos.ClientMetaService.Interface stub, AbstractRpcBasedConnectionRegistry.Callable<T> callable)
void	close() Closes this instance and releases any system resources associated with it
protected abstract CompletableFuture<Set<ServerName>>	fetchEndpoints()
CompletableFuture<ServerName>	getActiveMaster() Get the address of active HMaster.
protected abstract Set<ServerName>	getBootstrapNodes(org.apache.hadoop.conf.Configuration conf)
CompletableFuture<String>	getClusterId() Should only be called once.
CompletableFuture<RegionLocations>	getMetaRegionLocations() Get the location of meta region(s).
(package private) Set<ServerName>	getParsedServers()
private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> void	groupCall(CompletableFuture<T> future, Set<ServerName> servers, List<org.apache.hadoop.hbase.shaded.protobuf.generated.RegistryProtos.ClientMetaService.Interface> stubs, int startIndexInclusive, AbstractRpcBasedConnectionRegistry.Callable<T> callable, Predicate<T> isValidResp, String debug, ConcurrentLinkedQueue<Throwable> errors) send requests concurrently to hedgedReadsFanout end points.
private void	populateStubs(Set<ServerName> addrs)
private void	refreshStubs()
private static RegionLocations	transformMetaRegionLocations(org.apache.hadoop.hbase.shaded.protobuf.generated.RegistryProtos.GetMetaRegionLocationsResponse resp) Simple helper to transform the result of getMetaRegionLocations() rpc.

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.client.ConnectionRegistry

getConnectionString

Field Detail

HEDGED_REQS_FANOUT_DEFAULT

public static final int HEDGED_REQS_FANOUT_DEFAULT

Default value for the fan out of hedged requests.

See Also:

Constant Field Values

hedgedReadFanOut

private final int hedgedReadFanOut

addr2Stub

private volatile org.apache.hbase.thirdparty.com.google.common.collect.ImmutableMap<ServerName,org.apache.hadoop.hbase.shaded.protobuf.generated.RegistryProtos.ClientMetaService.Interface> addr2Stub

rpcClient

private final RpcClient rpcClient

rpcControllerFactory

private final RpcControllerFactory rpcControllerFactory

rpcTimeoutMs

private final int rpcTimeoutMs

registryEndpointRefresher

private final RegistryEndpointsRefresher registryEndpointRefresher

Constructor Detail

AbstractRpcBasedConnectionRegistry

protected AbstractRpcBasedConnectionRegistry(org.apache.hadoop.conf.Configuration conf,
                                             String hedgedReqsFanoutConfigName,
                                             String initialRefreshDelaySecsConfigName,
                                             String refreshIntervalSecsConfigName,
                                             String minRefreshIntervalSecsConfigName)
                                      throws IOException

Throws:

IOException

Method Detail

getBootstrapNodes

protected abstract Set<ServerName> getBootstrapNodes(org.apache.hadoop.conf.Configuration conf)
                                              throws IOException

Throws:

IOException

fetchEndpoints

protected abstract CompletableFuture<Set<ServerName>> fetchEndpoints()

refreshStubs

private void refreshStubs()
                   throws IOException

Throws:

IOException

populateStubs

private void populateStubs(Set<ServerName> addrs)
                    throws IOException

Throws:

IOException

call

private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> CompletableFuture<T> call(org.apache.hadoop.hbase.shaded.protobuf.generated.RegistryProtos.ClientMetaService.Interface stub,
                                                                                                      AbstractRpcBasedConnectionRegistry.Callable<T> callable)

badResponse

private IOException badResponse(String debug)

groupCall

private <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> void groupCall(CompletableFuture<T> future,
                                                                                           Set<ServerName> servers,
                                                                                           List<org.apache.hadoop.hbase.shaded.protobuf.generated.RegistryProtos.ClientMetaService.Interface> stubs,
                                                                                           int startIndexInclusive,
                                                                                           AbstractRpcBasedConnectionRegistry.Callable<T> callable,
                                                                                           Predicate<T> isValidResp,
                                                                                           String debug,
                                                                                           ConcurrentLinkedQueue<Throwable> errors)

send requests concurrently to hedgedReadsFanout end points. If any of the request is succeeded, we will complete the future and quit. If all the requests in one round are failed, we will start another round to send requests concurrently tohedgedReadsFanout end points. If all end points have been tried and all of them are failed, we will fail the future.

call

protected final <T extends org.apache.hbase.thirdparty.com.google.protobuf.Message> CompletableFuture<T> call(AbstractRpcBasedConnectionRegistry.Callable<T> callable,
                                                                                                              Predicate<T> isValidResp,
                                                                                                              String debug)

getParsedServers

Set<ServerName> getParsedServers()

transformMetaRegionLocations

private static RegionLocations transformMetaRegionLocations(org.apache.hadoop.hbase.shaded.protobuf.generated.RegistryProtos.GetMetaRegionLocationsResponse resp)

Simple helper to transform the result of getMetaRegionLocations() rpc.

getMetaRegionLocations

public CompletableFuture<RegionLocations> getMetaRegionLocations()

Description copied from interface: ConnectionRegistry

Get the location of meta region(s).

Specified by:

getMetaRegionLocations in interface ConnectionRegistry

getClusterId

public CompletableFuture<String> getClusterId()

Description copied from interface: ConnectionRegistry

Should only be called once.

The upper layer should store this value somewhere as it will not be change any more.

Specified by:

getClusterId in interface ConnectionRegistry

getActiveMaster

public CompletableFuture<ServerName> getActiveMaster()

Description copied from interface: ConnectionRegistry

Get the address of active HMaster.

Specified by:

getActiveMaster in interface ConnectionRegistry

close

public void close()

Description copied from interface: ConnectionRegistry

Closes this instance and releases any system resources associated with it

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface ConnectionRegistry