org.apache.hadoop.hbase.ipc
Class PayloadCarryingRpcController

java.lang.Object
  org.apache.hadoop.hbase.ipc.PayloadCarryingRpcController

All Implemented Interfaces:

com.google.protobuf.RpcController, CellScannable

Direct Known Subclasses:

DelegatingPayloadCarryingRpcController

@InterfaceAudience.Private
public class PayloadCarryingRpcController
extends Object
implements com.google.protobuf.RpcController, CellScannable

Optionally carries Cells across the proxy/service interface down into ipc. On its way out it optionally carries a set of result Cell data. We stick the Cells here when we want to avoid having to protobuf them. This class is used ferrying data across the proxy/protobuf service chasm. Used by client and server ipc'ing.

Constructor Summary

PayloadCarryingRpcController()

PayloadCarryingRpcController(CellScanner cellScanner)

PayloadCarryingRpcController(List<CellScannable> cellIterables)

Method Summary

CellScanner	cellScanner()
String	errorText()
boolean	failed()
int	getPriority()
boolean	isCanceled()
void	notifyOnCancel(com.google.protobuf.RpcCallback<Object> arg0)
void	reset()
void	setCellScanner(CellScanner cellScanner)
void	setFailed(String arg0)
void	setPriority(int priority)
void	setPriority(TableName tn)
void	startCancel()

Methods inherited from class java.lang.Object

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

Constructor Detail

PayloadCarryingRpcController

public PayloadCarryingRpcController()

PayloadCarryingRpcController

public PayloadCarryingRpcController(CellScanner cellScanner)

PayloadCarryingRpcController

public PayloadCarryingRpcController(List<CellScannable> cellIterables)

Method Detail

cellScanner

public CellScanner cellScanner()

Specified by:

cellScanner in interface CellScannable

Returns:

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

setCellScanner

public void setCellScanner(CellScanner cellScanner)

errorText

public String errorText()

Specified by:

errorText in interface com.google.protobuf.RpcController

failed

public boolean failed()

Specified by:

failed in interface com.google.protobuf.RpcController

isCanceled

public boolean isCanceled()

Specified by:

isCanceled in interface com.google.protobuf.RpcController

notifyOnCancel

public void notifyOnCancel(com.google.protobuf.RpcCallback<Object> arg0)

Specified by:

notifyOnCancel in interface com.google.protobuf.RpcController

reset

public void reset()

Specified by:

reset in interface com.google.protobuf.RpcController

setFailed

public void setFailed(String arg0)

Specified by:

setFailed in interface com.google.protobuf.RpcController

startCancel

public void startCancel()

Specified by:

startCancel in interface com.google.protobuf.RpcController

setPriority

public void setPriority(int priority)

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)

Parameters:

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

getPriority

public int getPriority()

Returns:

The priority of this request