Package org.apache.hadoop.hbase.client

Class AsyncScanSingleRegionRpcRetryingCaller.ScanControllerImpl

java.lang.Object

org.apache.hadoop.hbase.client.AsyncScanSingleRegionRpcRetryingCaller.ScanControllerImpl

All Implemented Interfaces:

AdvancedScanResultConsumer.ScanController

Enclosing class:

AsyncScanSingleRegionRpcRetryingCaller

private final class AsyncScanSingleRegionRpcRetryingCaller.ScanControllerImpl
extends Object
implements AdvancedScanResultConsumer.ScanController

Field Summary

Fields

Modifier and Type	Field	Description
private final Thread	callerThread
private final Optional<Cursor>	cursor
private AsyncScanSingleRegionRpcRetryingCaller.ScanResumerImpl	resumer
private AsyncScanSingleRegionRpcRetryingCaller.ScanControllerState	state

Constructor Summary

Constructors

Constructor	Description
ScanControllerImpl(Optional<Cursor> cursor)

Method Summary

Modifier and Type	Method	Description
Optional<Cursor>	cursor()	Get the scan cursor if available.
(package private) AsyncScanSingleRegionRpcRetryingCaller.ScanControllerState	destroy()
private void	preCheck()
AdvancedScanResultConsumer.ScanResumer	suspend()	Suspend the scan.
void	terminate()	Terminate the scan.

Methods inherited from class java.lang.Object

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

Field Details

callerThread

private final Thread callerThread

cursor

private final Optional<Cursor> cursor

state

private AsyncScanSingleRegionRpcRetryingCaller.ScanControllerState state

resumer

private AsyncScanSingleRegionRpcRetryingCaller.ScanResumerImpl resumer

Constructor Details

ScanControllerImpl

public ScanControllerImpl(Optional<Cursor> cursor)

Method Details

preCheck

private void preCheck()

suspend

public AdvancedScanResultConsumer.ScanResumer suspend()

Description copied from interface: AdvancedScanResultConsumer.ScanController

Suspend the scan.

This means we will stop fetching data in background, i.e., will not call onNext any more before you resume the scan.

Specified by:

suspend in interface AdvancedScanResultConsumer.ScanController

Returns:

A resumer used to resume the scan later.

terminate

public void terminate()

Description copied from interface: AdvancedScanResultConsumer.ScanController

Terminate the scan.

This is useful when you have got enough results and want to stop the scan in onNext method, or you want to stop the scan in onHeartbeat method because it has spent too many time.

Specified by:

terminate in interface AdvancedScanResultConsumer.ScanController

destroy

AsyncScanSingleRegionRpcRetryingCaller.ScanControllerState destroy()

cursor

public Optional<Cursor> cursor()

Description copied from interface: AdvancedScanResultConsumer.ScanController

Get the scan cursor if available.

Specified by:

cursor in interface AdvancedScanResultConsumer.ScanController

Returns:

The scan cursor.