org.hbase.async

Class HBaseRpc

java.lang.Object

org.hbase.async.HBaseRpc

Direct Known Subclasses:

AppendRequest, AtomicIncrementRequest, DeleteRequest, GetRequest, MultiColumnAtomicIncrementRequest, PutRequest, RowLockRequest

public abstract class HBaseRpc
extends Object

Abstract base class for all RPC requests going out to HBase.

Implementations of this class are not expected to be synchronized.

A note on passing byte arrays in argument

None of the method that receive a byte[] in argument will copy it. If you change the contents of any byte array you give to an instance of this class, you may affect the behavior of the request in an unpredictable way. If you need to change the byte array, clone it before giving it to this class. For those familiar with the term "defensive copy", we don't do it in order to avoid unnecessary memory copies when you know you won't be changing (or event holding a reference to) the byte array, which is frequently the case.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HBaseRpc.HasFamily An RPC from which you can get a family name.
static interface	HBaseRpc.HasKey An RPC from which you can get a row key name.
static interface	HBaseRpc.HasQualifier An RPC from which you can get a column qualifier name.
static interface	HBaseRpc.HasQualifiers An RPC from which you can get multiple column qualifier names.
static interface	HBaseRpc.HasTable An RPC from which you can get a table name.
static interface	HBaseRpc.HasTimestamp An RPC from which you can get a timestamp.
static interface	HBaseRpc.HasValue An RPC from which you can get a value.
static interface	HBaseRpc.HasValues An RPC from which you can get multiple values.

Method Summary

Modifier and Type	Method and Description
boolean	failfast() Returns whether the RPC not be retried upon encountering a problem.
int	getTimeout() An optional timeout for the RPC in milliseconds.
boolean	isProbe()
boolean	isTraceRPC()
boolean	setFailfast(boolean failfast) Set whether the RPC not be retried upon encountering a problem.
void	setProbe(boolean probe)
void	setTimeout(int timeout) A timeout, in milliseconds, to set for this RPC.
void	setTraceRPC(boolean trace_rpc)
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

isTraceRPC

public boolean isTraceRPC()

setTraceRPC

public void setTraceRPC(boolean trace_rpc)

setFailfast

public final boolean setFailfast(boolean failfast)

Set whether the RPC not be retried upon encountering a problem.

RPCs can be retried for various legitimate reasons (e.g. NSRE due to a region moving), but under certain failure circumstances (such as a node going down) we want to give up and be alerted as soon as possible.

Parameters:

failfast - If true, this RPC should fail-fast as soon as we know we have a problem.

Returns:

whether the RPC not be retried upon encountering a problem.

Since:

1.5

failfast

public final boolean failfast()

Returns whether the RPC not be retried upon encountering a problem.

Returns:

whether the RPC not be retried upon encountering a problem.

Since:

1.5

See Also:

setFailfast(boolean)

isProbe

public boolean isProbe()

setProbe

public void setProbe(boolean probe)

setTimeout

public void setTimeout(int timeout)

A timeout, in milliseconds, to set for this RPC. If the RPC cannot be sent and processed by HBase within this period then a RpcTimedOutException will be returned in the deferred.

If no timeout is set, then "hbase.rpc.timeout" will be used by default. However if a value of "0" is supplied as the timeout, then the RPC will not be timed out.

Parameters:

timeout - The timeout in milliseconds.

Throws:

IllegalArgumentException - if the value is less than zero

Since:

1.7

getTimeout

public int getTimeout()

An optional timeout for the RPC in milliseconds. Note that the initial value is -1, meaning the RPC will use the default value configured in hbase.rpc.timeout.

Returns:

The timeout value in milliseconds.

toString

public String toString()

Overrides:

toString in class Object