PayloadCarryingRpcController (Apache HBase 1.2.12 API)

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

All Implemented Interfaces:

com.google.protobuf.RpcController, CellScannable

Direct Known Subclasses:

DelegatingPayloadCarryingRpcController
```
@InterfaceAudience.Private
public class PayloadCarryingRpcController
extends TimeLimitedRpcController
implements 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.

Field Summary

Fields
Modifier and Type	Field and Description
`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 int`	`priority` Priority to set on this request.

Fields inherited from class org.apache.hadoop.hbase.ipc.TimeLimitedRpcController
callTimeout, cancellationCb, cancelled, failureCb

Constructor Summary

Constructors
Constructor and Description
`PayloadCarryingRpcController()`
`PayloadCarryingRpcController(CellScanner cellScanner)`
`PayloadCarryingRpcController(List<CellScannable> cellIterables)`

Method Summary

Methods
Modifier and Type	Method and Description
`CellScanner`	`cellScanner()`
`int`	`getPriority()`
`void`	`reset()`
`void`	`setCellScanner(CellScanner cellScanner)`
`void`	`setPriority(int priority)`
`void`	`setPriority(TableName tn)`

Methods inherited from class org.apache.hadoop.hbase.ipc.TimeLimitedRpcController
errorText, failed, getCallTimeout, hasCallTimeout, isCanceled, notifyOnCancel, notifyOnFail, setCallTimeout, setFailed, setFailed, startCancel

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - 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
  - 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)
```
  - 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
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface com.google.protobuf.RpcController
    
    Overrides:
    
    reset in class TimeLimitedRpcController

Class PayloadCarryingRpcController

Field Summary

Fields inherited from class org.apache.hadoop.hbase.ipc.TimeLimitedRpcController

Constructor Summary

Method Summary

Methods inherited from class org.apache.hadoop.hbase.ipc.TimeLimitedRpcController

Methods inherited from class java.lang.Object

Field Detail

priority

cellScanner

Constructor Detail

PayloadCarryingRpcController

PayloadCarryingRpcController

PayloadCarryingRpcController

Method Detail

cellScanner

setCellScanner

setPriority

setPriority

getPriority

reset