org.apache.hadoop.hbase.client

Class NoopPartialResultCoprocessorCallback<S,R>

java.lang.Object

org.apache.hadoop.hbase.client.NoopPartialResultCoprocessorCallback<S,R>

All Implemented Interfaces:

AsyncTable.CoprocessorCallback<R>, AsyncTable.PartialResultCoprocessorCallback<S,R>

@InterfaceAudience.Private
public class NoopPartialResultCoprocessorCallback<S,R>
extends Object
implements AsyncTable.PartialResultCoprocessorCallback<S,R>

Constructor Summary

Constructors

Constructor and Description
NoopPartialResultCoprocessorCallback(AsyncTable.CoprocessorCallback<R> delegate)

Method Summary

Modifier and Type	Method and Description
ServiceCaller<S,R>	getNextCallable(R response, RegionInfo region) Subclasses should implement this to tell AsyncTable whether the given response is "final" or whether the AsyncTable should send another request to the coprocessor to fetch more results from the given region.
Duration	getWaitInterval(R response, RegionInfo region) Subclasses should implement this such that, when the above method returns non-null, this method returns the duration that AsyncTable should wait before sending the next request to the given region.
void	onComplete() Indicate that all responses of the regions have been notified by calling AsyncTable.CoprocessorCallback.onRegionComplete(RegionInfo, Object) or AsyncTable.CoprocessorCallback.onRegionError(RegionInfo, Throwable).
void	onError(Throwable error) Indicate that we got an error which does not belong to any regions.
void	onRegionComplete(RegionInfo region, R resp) Indicate that the respose of a region is available
void	onRegionError(RegionInfo region, Throwable error) Indicate that the error for a region is available

Methods inherited from class java.lang.Object

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

Constructor Detail

NoopPartialResultCoprocessorCallback

public NoopPartialResultCoprocessorCallback(AsyncTable.CoprocessorCallback<R> delegate)

Method Detail

onRegionComplete

public void onRegionComplete(RegionInfo region,
                             R resp)

Description copied from interface: AsyncTable.CoprocessorCallback

Indicate that the respose of a region is available

Specified by:

onRegionComplete in interface AsyncTable.CoprocessorCallback<R>

Parameters:

region - the region that the response belongs to

resp - the response of the coprocessor call

onRegionError

public void onRegionError(RegionInfo region,
                          Throwable error)

Description copied from interface: AsyncTable.CoprocessorCallback

Indicate that the error for a region is available

Specified by:

onRegionError in interface AsyncTable.CoprocessorCallback<R>

Parameters:

region - the region that the error belongs to

error - the response error of the coprocessor call

onComplete

public void onComplete()

Description copied from interface: AsyncTable.CoprocessorCallback

Indicate that all responses of the regions have been notified by calling AsyncTable.CoprocessorCallback.onRegionComplete(RegionInfo, Object) or AsyncTable.CoprocessorCallback.onRegionError(RegionInfo, Throwable).

Specified by:

onComplete in interface AsyncTable.CoprocessorCallback<R>

onError

public void onError(Throwable error)

Description copied from interface: AsyncTable.CoprocessorCallback

Indicate that we got an error which does not belong to any regions. Usually a locating error.

Specified by:

onError in interface AsyncTable.CoprocessorCallback<R>

getNextCallable

public ServiceCaller<S,R> getNextCallable(R response,
                                          RegionInfo region)

Description copied from interface: AsyncTable.PartialResultCoprocessorCallback

Subclasses should implement this to tell AsyncTable whether the given response is "final" or whether the AsyncTable should send another request to the coprocessor to fetch more results from the given region. This method of fetching more results can be used many times until there are no more results to fetch from the region.

Specified by:

getNextCallable in interface AsyncTable.PartialResultCoprocessorCallback<S,R>

Parameters:

response - The response received from the coprocessor

region - The region the response came from

Returns:

A ServiceCaller object if the response was not final and therefore another request is required to continuing fetching results. null if no more requests need to be sent to the region.

getWaitInterval

public Duration getWaitInterval(R response,
                                RegionInfo region)

Description copied from interface: AsyncTable.PartialResultCoprocessorCallback

Subclasses should implement this such that, when the above method returns non-null, this method returns the duration that AsyncTable should wait before sending the next request to the given region. You can use this to create a back-off behavior to reduce load on the RegionServer. If that's not desired, you can always return Duration.ZERO.

Specified by:

getWaitInterval in interface AsyncTable.PartialResultCoprocessorCallback<S,R>

Parameters:

response - The response received from the coprocessor

region - The region the response came from

Returns:

The duration to wait.