HBaseRpcController (Apache HBase 1.4.11 API)

All Superinterfaces:

CellScannable, com.google.protobuf.RpcController

All Known Implementing Classes:

DelegatingHBaseRpcController, HBaseRpcControllerImpl
```
@InterfaceAudience.Private
public interface HBaseRpcController
extends 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 (for performance reasons). This class is used ferrying data across the proxy/protobuf service chasm. Also does call timeout. Used by client and server ipc'ing.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface HBaseRpcController.CancellationCallback

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`HBaseRpcController.CancellationCallback`

Method Summary

Methods
Modifier and Type	Method and Description
`int`	`getCallTimeout()`
`IOException`	`getFailed()` Return the failed exception, null if not failed.
`int`	`getPriority()`
`boolean`	`hasCallTimeout()`
`void`	`notifyOnCancel(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(com.google.protobuf.RpcCallback<Object> callback, HBaseRpcController.CancellationCallback action)` If not cancelled, add the callback to cancellation callback list.
`void`	`setCallTimeout(int callTimeout)`
`void`	`setCellScanner(CellScanner cellScanner)` Only used to send cells to rpc server, the returned cells should be set by `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`	`setPriority(int priority)`
`void`	`setPriority(TableName tn)`

Methods inherited from interface com.google.protobuf.RpcController
errorText, failed, isCanceled, reset, setFailed, startCancel

Methods inherited from interface org.apache.hadoop.hbase.CellScannable
cellScanner

- Method Detail
  - setCellScanner
```
void setCellScanner(CellScanner cellScanner)
```
    Only used to send cells to rpc server, the returned cells should be set by setDone(CellScanner).
  - setPriority
```
void setPriority(int priority)
```
    Parameters:
    priority - Priority for this request; should fall roughly in the range HConstants.NORMAL_QOS to HConstants.HIGH_QOS
  - setPriority
```
void setPriority(TableName tn)
```
    Parameters:
    tn - Set priority based off the table we are going against.
  - getPriority
```
int getPriority()
```
    Returns:
    The priority of this request
  - getCallTimeout
```
int getCallTimeout()
```
  - setCallTimeout
```
void setCallTimeout(int callTimeout)
```
  - hasCallTimeout
```
boolean hasCallTimeout()
```
  - setFailed
```
void setFailed(IOException e)
```
    Set failed with an exception to pass on. For use in async rpc clients
    
    Parameters:
    e - exception to set with
  - getFailed
```
IOException getFailed()
```
    Return the failed exception, null if not failed.
  - setDone
```
void setDone(CellScanner cellScanner)
```
    IMPORTANT: always call this method if the call finished without any exception to tell the HBaseRpcController that we are done.
  - notifyOnCancel
```
void notifyOnCancel(com.google.protobuf.RpcCallback<Object> callback)
```
    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 com.google.protobuf.RpcController
  - notifyOnCancel
```
void notifyOnCancel(com.google.protobuf.RpcCallback<Object> callback,
                  HBaseRpcController.CancellationCallback action)
                    throws IOException
```
    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.
    
    Throws:
    
    IOException

Interface HBaseRpcController

Nested Class Summary

Method Summary

Methods inherited from interface com.google.protobuf.RpcController

Methods inherited from interface org.apache.hadoop.hbase.CellScannable

Method Detail

setCellScanner

setPriority

setPriority

getPriority

getCallTimeout

setCallTimeout

hasCallTimeout

setFailed

getFailed

setDone

notifyOnCancel

notifyOnCancel