TimeLimitedRpcController (Apache HBase 1.2.12 API)

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

All Implemented Interfaces:: com.google.protobuf.RpcController

Direct Known Subclasses:: PayloadCarryingRpcController

@InterfaceAudience.Private
public class TimeLimitedRpcController
extends Object
implements com.google.protobuf.RpcController

Field Summary

Fields
Modifier and Type	Field and Description
`protected Integer`	`callTimeout` The time, in ms before the call should expire.
`protected AtomicReference<com.google.protobuf.RpcCallback<Object>>`	`cancellationCb`
`protected boolean`	`cancelled`
`private IOException`	`exception`
`protected AtomicReference<com.google.protobuf.RpcCallback<IOException>>`	`failureCb`

Constructor Summary

Constructors
Constructor and Description

TimeLimitedRpcController()

Constructors
Constructor and Description
`TimeLimitedRpcController()`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`errorText()`
`boolean`	`failed()` For use in async rpc clients
`int`	`getCallTimeout()`
`boolean`	`hasCallTimeout()`
`boolean`	`isCanceled()`
`void`	`notifyOnCancel(com.google.protobuf.RpcCallback<Object> cancellationCb)`
`void`	`notifyOnFail(com.google.protobuf.RpcCallback<IOException> failureCb)` Notify a callback on error.
`void`	`reset()`
`void`	`setCallTimeout(int callTimeout)`
`void`	`setFailed(IOException e)` Set failed with an exception to pass on.
`void`	`setFailed(String reason)`
`void`	`startCancel()`

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

- Field Detail
  - callTimeout
```
protected volatile Integer callTimeout
```
    The time, in ms before the call should expire.
  - cancelled
```
protected volatile boolean cancelled
```
  - cancellationCb
```
protected final AtomicReference<com.google.protobuf.RpcCallback<Object>> cancellationCb
```
  - failureCb
```
protected final AtomicReference<com.google.protobuf.RpcCallback<IOException>> failureCb
```
  - exception
```
private IOException exception
```
- Constructor Detail
  - TimeLimitedRpcController
```
public TimeLimitedRpcController()
```
- Method Detail
  - getCallTimeout
```
public int getCallTimeout()
```
  - setCallTimeout
```
public void setCallTimeout(int callTimeout)
```
  - hasCallTimeout
```
public boolean hasCallTimeout()
```
  - errorText
```
public String errorText()
```
    Specified by:
    
    errorText in interface com.google.protobuf.RpcController
  - failed
```
public boolean failed()
```
    For use in async rpc clients
    
    Specified by:
    
    failed in interface com.google.protobuf.RpcController
    
    Returns:
    true if failed
  - isCanceled
```
public boolean isCanceled()
```
    Specified by:
    
    isCanceled in interface com.google.protobuf.RpcController
  - notifyOnCancel
```
public void notifyOnCancel(com.google.protobuf.RpcCallback<Object> cancellationCb)
```
    Specified by:
    
    notifyOnCancel in interface com.google.protobuf.RpcController
  - notifyOnFail
```
public void notifyOnFail(com.google.protobuf.RpcCallback<IOException> failureCb)
```
    Notify a callback on error. For use in async rpc clients
    
    Parameters:
    failureCb - the callback to call on error
  - reset
```
public void reset()
```
    Specified by:
    
    reset in interface com.google.protobuf.RpcController
  - setFailed
```
public void setFailed(String reason)
```
    Specified by:
    
    setFailed in interface com.google.protobuf.RpcController
  - setFailed
```
public void setFailed(IOException e)
```
    Set failed with an exception to pass on. For use in async rpc clients
    
    Parameters:
    e - exception to set with
  - startCancel
```
public void startCancel()
```
    Specified by:
    
    startCancel in interface com.google.protobuf.RpcController

Class TimeLimitedRpcController

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

callTimeout

cancelled

cancellationCb

failureCb

exception

Constructor Detail

TimeLimitedRpcController

Method Detail

getCallTimeout

setCallTimeout

hasCallTimeout

errorText

failed

isCanceled

notifyOnCancel

notifyOnFail

reset

setFailed

setFailed

startCancel