org.apache.hadoop.hbase.client

Class AsyncTableBuilderBase<C extends ScanResultConsumerBase>

java.lang.Object

org.apache.hadoop.hbase.client.AsyncTableBuilderBase<C>

All Implemented Interfaces:

AsyncTableBuilder<C>

@InterfaceAudience.Private
abstract class AsyncTableBuilderBase<C extends ScanResultConsumerBase>
extends Object
implements AsyncTableBuilder<C>

Base class for all asynchronous table builders.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	maxAttempts
protected long	operationTimeoutNs
protected long	pauseNs
protected long	pauseNsForServerOverloaded
protected long	readRpcTimeoutNs
protected long	rpcTimeoutNs
protected long	scanTimeoutNs
protected int	startLogErrorsCnt
protected TableName	tableName
protected long	writeRpcTimeoutNs

Constructor Summary

Constructors

Constructor and Description
AsyncTableBuilderBase(TableName tableName, AsyncConnectionConfiguration connConf)

Method Summary

Modifier and Type	Method and Description
AsyncTableBuilderBase<C>	setMaxAttempts(int maxAttempts) Set the max attempt times for an operation.
AsyncTableBuilderBase<C>	setOperationTimeout(long timeout, TimeUnit unit) Set timeout for a whole operation such as get, put or delete.
AsyncTableBuilderBase<C>	setReadRpcTimeout(long timeout, TimeUnit unit) Set timeout for each read(get, scan) rpc request.
AsyncTableBuilderBase<C>	setRetryPause(long pause, TimeUnit unit) Set the base pause time for retrying.
AsyncTableBuilderBase<C>	setRetryPauseForServerOverloaded(long pause, TimeUnit unit) Set the base pause time for retrying when HBaseServerException.isServerOverloaded().
AsyncTableBuilderBase<C>	setRpcTimeout(long timeout, TimeUnit unit) Set timeout for each rpc request.
AsyncTableBuilderBase<C>	setScanTimeout(long timeout, TimeUnit unit) As now we have heartbeat support for scan, ideally a scan will never timeout unless the RS is crash.
AsyncTableBuilderBase<C>	setStartLogErrorsCnt(int startLogErrorsCnt) Set the number of retries that are allowed before we start to log.
AsyncTableBuilderBase<C>	setWriteRpcTimeout(long timeout, TimeUnit unit) Set timeout for each write(put, delete) rpc request.

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.AsyncTableBuilder

build, setMaxRetries, setRetryPauseForCQTBE

Field Detail

tableName

protected TableName tableName

operationTimeoutNs

protected long operationTimeoutNs

scanTimeoutNs

protected long scanTimeoutNs

rpcTimeoutNs

protected long rpcTimeoutNs

readRpcTimeoutNs

protected long readRpcTimeoutNs

writeRpcTimeoutNs

protected long writeRpcTimeoutNs

pauseNs

protected long pauseNs

pauseNsForServerOverloaded

protected long pauseNsForServerOverloaded

maxAttempts

protected int maxAttempts

startLogErrorsCnt

protected int startLogErrorsCnt

Constructor Detail

AsyncTableBuilderBase

AsyncTableBuilderBase(TableName tableName,
                      AsyncConnectionConfiguration connConf)

Method Detail

setOperationTimeout

public AsyncTableBuilderBase<C> setOperationTimeout(long timeout,
                                                    TimeUnit unit)

Description copied from interface: AsyncTableBuilder

Set timeout for a whole operation such as get, put or delete. Notice that scan will not be effected by this value, see scanTimeoutNs.

Operation timeout and max attempt times(or max retry times) are both limitations for retrying, we will stop retrying when we reach any of the limitations.

Specified by:

setOperationTimeout in interface AsyncTableBuilder<C extends ScanResultConsumerBase>

See Also:

AsyncTableBuilder.setMaxAttempts(int), AsyncTableBuilder.setMaxRetries(int), AsyncTableBuilder.setScanTimeout(long, TimeUnit)

setScanTimeout

public AsyncTableBuilderBase<C> setScanTimeout(long timeout,
                                               TimeUnit unit)

Description copied from interface: AsyncTableBuilder

As now we have heartbeat support for scan, ideally a scan will never timeout unless the RS is crash. The RS will always return something before the rpc timed out or scan timed out to tell the client that it is still alive. The scan timeout is used as operation timeout for every operation in a scan, such as openScanner or next.

Specified by:

setScanTimeout in interface AsyncTableBuilder<C extends ScanResultConsumerBase>

See Also:

AsyncTableBuilder.setScanTimeout(long, TimeUnit)

setRpcTimeout

public AsyncTableBuilderBase<C> setRpcTimeout(long timeout,
                                              TimeUnit unit)

Description copied from interface: AsyncTableBuilder

Set timeout for each rpc request.

Notice that this will NOT change the rpc timeout for read(get, scan) request and write request(put, delete).

Specified by:

setRpcTimeout in interface AsyncTableBuilder<C extends ScanResultConsumerBase>

setReadRpcTimeout

public AsyncTableBuilderBase<C> setReadRpcTimeout(long timeout,
                                                  TimeUnit unit)

Description copied from interface: AsyncTableBuilder

Set timeout for each read(get, scan) rpc request.

Specified by:

setReadRpcTimeout in interface AsyncTableBuilder<C extends ScanResultConsumerBase>

setWriteRpcTimeout

public AsyncTableBuilderBase<C> setWriteRpcTimeout(long timeout,
                                                   TimeUnit unit)

Description copied from interface: AsyncTableBuilder

Set timeout for each write(put, delete) rpc request.

Specified by:

setWriteRpcTimeout in interface AsyncTableBuilder<C extends ScanResultConsumerBase>

setRetryPause

public AsyncTableBuilderBase<C> setRetryPause(long pause,
                                              TimeUnit unit)

Description copied from interface: AsyncTableBuilder

Set the base pause time for retrying. We use an exponential policy to generate sleep time when retrying.

Specified by:

setRetryPause in interface AsyncTableBuilder<C extends ScanResultConsumerBase>

See Also:

AsyncTableBuilder.setRetryPauseForServerOverloaded(long, TimeUnit)

setRetryPauseForServerOverloaded

public AsyncTableBuilderBase<C> setRetryPauseForServerOverloaded(long pause,
                                                                 TimeUnit unit)

Description copied from interface: AsyncTableBuilder

Set the base pause time for retrying when HBaseServerException.isServerOverloaded(). We use an exponential policy to generate sleep time when retrying.

This value should be greater than the normal pause value which could be set with the above AsyncTableBuilder.setRetryPause(long, TimeUnit) method, as usually HBaseServerException.isServerOverloaded() means the server is overloaded. We just use the normal pause value for HBaseServerException.isServerOverloaded() if here you specify a smaller value.

Specified by:

setRetryPauseForServerOverloaded in interface AsyncTableBuilder<C extends ScanResultConsumerBase>

See Also:

AsyncTableBuilder.setRetryPause(long, TimeUnit)

setMaxAttempts

public AsyncTableBuilderBase<C> setMaxAttempts(int maxAttempts)

Description copied from interface: AsyncTableBuilder

Set the max attempt times for an operation. Usually it is the max retry times plus 1. Operation timeout and max attempt times(or max retry times) are both limitations for retrying, we will stop retrying when we reach any of the limitations.

Specified by:

setMaxAttempts in interface AsyncTableBuilder<C extends ScanResultConsumerBase>

See Also:

AsyncTableBuilder.setMaxRetries(int), AsyncTableBuilder.setOperationTimeout(long, TimeUnit)

setStartLogErrorsCnt

public AsyncTableBuilderBase<C> setStartLogErrorsCnt(int startLogErrorsCnt)

Description copied from interface: AsyncTableBuilder

Set the number of retries that are allowed before we start to log.

Specified by:

setStartLogErrorsCnt in interface AsyncTableBuilder<C extends ScanResultConsumerBase>