org.apache.hadoop.hbase.ipc

Class HBaseRpcControllerImpl

java.lang.Object

org.apache.hadoop.hbase.ipc.HBaseRpcControllerImpl

All Implemented Interfaces:

CellScannable, HBaseRpcController, org.apache.hbase.thirdparty.com.google.protobuf.RpcController

@InterfaceAudience.Private
public class HBaseRpcControllerImpl
extends Object
implements HBaseRpcController

Get instances via RpcControllerFactory on client-side.

See Also:

RpcControllerFactory

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.ipc.HBaseRpcController

HBaseRpcController.CancellationCallback

Field Summary

Fields

Modifier and Type	Field and Description
private Integer	callTimeout The time, in ms before the call should expire.
private List<org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<Object>>	cancellationCbs
private boolean	cancelled
private CellScanner	cellScanner They are optionally set on construction, cleared after we make the call, and then optionally set on response with the result.
private boolean	done
private IOException	exception
private int	priority Priority to set on this request.
private RegionInfo	regionInfo Rpc target Region's RegionInfo we are going against.

Constructor Summary

Constructors

Constructor and Description
HBaseRpcControllerImpl()
HBaseRpcControllerImpl(CellScanner cellScanner) Used server-side.
HBaseRpcControllerImpl(RegionInfo regionInfo, CellScanner cellScanner)
HBaseRpcControllerImpl(RegionInfo regionInfo, List<CellScannable> cellIterables)

Method Summary

Modifier and Type	Method and Description
CellScanner	cellScanner() Returns One-shot cell scanner (you cannot back it up and restart)
String	errorText()
boolean	failed()
int	getCallTimeout()
IOException	getFailed() Return the failed exception, null if not failed.
int	getPriority() Returns The priority of this request
RegionInfo	getRegionInfo() Returns Target Region's RegionInfo or null if not available or pertinent.
boolean	hasCallTimeout()
boolean	hasRegionInfo() Returns True if this Controller is carrying the RPC target Region's RegionInfo.
boolean	isCanceled()
void	notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<Object> callback) A little different from the basic RpcController: You can register multiple callbacks to an HBaseRpcController. The callback will not be called if the rpc call is finished without any cancellation. You can call me at client side also.
void	notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<Object> callback, HBaseRpcController.CancellationCallback action) If not cancelled, add the callback to cancellation callback list.
void	reset()
void	setCallTimeout(int callTimeout)
void	setCellScanner(CellScanner cellScanner) Only used to send cells to rpc server, the returned cells should be set by HBaseRpcController.setDone(CellScanner).
void	setDone(CellScanner cellScanner) IMPORTANT: always call this method if the call finished without any exception to tell the HBaseRpcController that we are done.
void	setFailed(IOException e) Set failed with an exception to pass on.
void	setFailed(String reason)
void	setPriority(int priority) Set the priority for this operation.
void	setPriority(TableName tn) Set the priority for this operation.
void	startCancel()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

callTimeout

private Integer callTimeout

The time, in ms before the call should expire.

done

private boolean done

cancelled

private boolean cancelled

cancellationCbs

private final List<org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<Object>> cancellationCbs

exception

private IOException exception

regionInfo

private RegionInfo regionInfo

Rpc target Region's RegionInfo we are going against. May be null.

See Also:

hasRegionInfo()

priority

private int priority

Priority to set on this request. Set it here in controller so available composing the request. This is the ordained way of setting priorities going forward. We will be undoing the old annotation-based mechanism.

cellScanner

private CellScanner cellScanner

They are optionally set on construction, cleared after we make the call, and then optionally set on response with the result. We use this lowest common denominator access to Cells because sometimes the scanner is backed by a List of Cells and other times, it is backed by an encoded block that implements CellScanner.

Constructor Detail

HBaseRpcControllerImpl

public HBaseRpcControllerImpl()

HBaseRpcControllerImpl

public HBaseRpcControllerImpl(CellScanner cellScanner)

Used server-side. Clients should go via RpcControllerFactory

HBaseRpcControllerImpl

HBaseRpcControllerImpl(RegionInfo regionInfo,
                       CellScanner cellScanner)

HBaseRpcControllerImpl

HBaseRpcControllerImpl(RegionInfo regionInfo,
                       List<CellScannable> cellIterables)

Method Detail

hasRegionInfo

public boolean hasRegionInfo()

Description copied from interface: HBaseRpcController

Returns True if this Controller is carrying the RPC target Region's RegionInfo.

Specified by:

hasRegionInfo in interface HBaseRpcController

getRegionInfo

public RegionInfo getRegionInfo()

Description copied from interface: HBaseRpcController

Returns Target Region's RegionInfo or null if not available or pertinent.

Specified by:

getRegionInfo in interface HBaseRpcController

cellScanner

public CellScanner cellScanner()

Returns One-shot cell scanner (you cannot back it up and restart)

Specified by:

cellScanner in interface CellScannable

setCellScanner

public void setCellScanner(CellScanner cellScanner)

Description copied from interface: HBaseRpcController

Only used to send cells to rpc server, the returned cells should be set by HBaseRpcController.setDone(CellScanner).

Specified by:

setCellScanner in interface HBaseRpcController

setPriority

public void setPriority(int priority)

Description copied from interface: HBaseRpcController

Set the priority for this operation.

Specified by:

setPriority in interface HBaseRpcController

Parameters:

priority - Priority for this request; should fall roughly in the range HConstants.NORMAL_QOS to HConstants.HIGH_QOS

setPriority

public void setPriority(TableName tn)

Description copied from interface: HBaseRpcController

Set the priority for this operation.

Specified by:

setPriority in interface HBaseRpcController

Parameters:

tn - Set priority based off the table we are going against.

getPriority

public int getPriority()

Description copied from interface: HBaseRpcController

Returns The priority of this request

Specified by:

getPriority in interface HBaseRpcController

reset

public void reset()

Specified by:

reset in interface org.apache.hbase.thirdparty.com.google.protobuf.RpcController

getCallTimeout

public int getCallTimeout()

Specified by:

getCallTimeout in interface HBaseRpcController

setCallTimeout

public void setCallTimeout(int callTimeout)

Specified by:

setCallTimeout in interface HBaseRpcController

hasCallTimeout

public boolean hasCallTimeout()

Specified by:

hasCallTimeout in interface HBaseRpcController

errorText

public String errorText()

Specified by:

errorText in interface org.apache.hbase.thirdparty.com.google.protobuf.RpcController

failed

public boolean failed()

Specified by:

failed in interface org.apache.hbase.thirdparty.com.google.protobuf.RpcController

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface org.apache.hbase.thirdparty.com.google.protobuf.RpcController

notifyOnCancel

public void notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<Object> callback)

Description copied from interface: HBaseRpcController

A little different from the basic RpcController:

1. You can register multiple callbacks to an HBaseRpcController.
2. The callback will not be called if the rpc call is finished without any cancellation.
3. You can call me at client side also.

Specified by:

notifyOnCancel in interface HBaseRpcController

Specified by:

notifyOnCancel in interface org.apache.hbase.thirdparty.com.google.protobuf.RpcController

setFailed

public void setFailed(String reason)

Specified by:

setFailed in interface org.apache.hbase.thirdparty.com.google.protobuf.RpcController

setFailed

public void setFailed(IOException e)

Description copied from interface: HBaseRpcController

Set failed with an exception to pass on. For use in async rpc clients

Specified by:

setFailed in interface HBaseRpcController

Parameters:

e - exception to set with

getFailed

public IOException getFailed()

Description copied from interface: HBaseRpcController

Return the failed exception, null if not failed.

Specified by:

getFailed in interface HBaseRpcController

setDone

public void setDone(CellScanner cellScanner)

Description copied from interface: HBaseRpcController

IMPORTANT: always call this method if the call finished without any exception to tell the HBaseRpcController that we are done.

Specified by:

setDone in interface HBaseRpcController

startCancel

public void startCancel()

Specified by:

startCancel in interface org.apache.hbase.thirdparty.com.google.protobuf.RpcController

notifyOnCancel

public void notifyOnCancel(org.apache.hbase.thirdparty.com.google.protobuf.RpcCallback<Object> callback,
                           HBaseRpcController.CancellationCallback action)
                    throws IOException

Description copied from interface: HBaseRpcController

If not cancelled, add the callback to cancellation callback list. And then execute the action with the cancellation state as a parameter. The implementation should guarantee that the cancellation state does not change during this call.

Specified by:

notifyOnCancel in interface HBaseRpcController

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object