RpcExecutor (Apache HBase 1.4.11 API)

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

Direct Known Subclasses:

BalancedQueueRpcExecutor, RWQueueRpcExecutor
```
@InterfaceAudience.Private
public abstract class RpcExecutor
extends Object
```
Runs the CallRunners passed here via dispatch(CallRunner). Subclass and add particular scheduling behavior.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class RpcExecutor.Handler
Handler thread run the CallRunner.run() in.

static class RpcExecutor.QueueBalancer

Nested Classes
Modifier and Type	Class and Description
`protected class`	`RpcExecutor.Handler` Handler thread run the `CallRunner.run()` in.
`static class`	`RpcExecutor.QueueBalancer`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CALL_QUEUE_CODEL_DEFAULT_INTERVAL`
`static double`	`CALL_QUEUE_CODEL_DEFAULT_LIFO_THRESHOLD`
`static int`	`CALL_QUEUE_CODEL_DEFAULT_TARGET_DELAY`
`static String`	`CALL_QUEUE_CODEL_INTERVAL`
`static String`	`CALL_QUEUE_CODEL_LIFO_THRESHOLD`
`static String`	`CALL_QUEUE_CODEL_TARGET_DELAY`
`static String`	`CALL_QUEUE_HANDLER_FACTOR_CONF_KEY`
`static String`	`CALL_QUEUE_TYPE_CODEL_CONF_VALUE` The default, 'fifo', has the least friction but is dumb.
`static String`	`CALL_QUEUE_TYPE_CONF_DEFAULT`
`static String`	`CALL_QUEUE_TYPE_CONF_KEY`
`static String`	`CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE`
`static String`	`CALL_QUEUE_TYPE_FIFO_CONF_VALUE`
`protected int`	`currentQueueLimit`
`protected static int`	`DEFAULT_CALL_QUEUE_SIZE_HARD_LIMIT`
`protected int`	`numCallQueues`
`static String`	`QUEUE_MAX_CALL_DELAY_CONF_KEY` max delay in msec used to bound the deprioritized requests
`protected List<BlockingQueue<CallRunner>>`	`queues`

Constructor Summary

Constructors
Constructor and Description
`RpcExecutor(String name, int handlerCount, int numCallQueues)` Deprecated.
`RpcExecutor(String name, int handlerCount, int numCallQueues, org.apache.hadoop.conf.Configuration conf, Abortable abortable)` Deprecated.
`RpcExecutor(String name, int handlerCount, int maxQueueLength, PriorityFunction priority, org.apache.hadoop.conf.Configuration conf, Abortable abortable)`
`RpcExecutor(String name, int handlerCount, String callQueueType, int maxQueueLength, PriorityFunction priority, org.apache.hadoop.conf.Configuration conf, Abortable abortable)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected int`	`computeNumCallQueues(int handlerCount, float callQueuesHandlersFactor)`
`abstract boolean`	`dispatch(CallRunner callTask)` Add the request to the executor queue
`int`	`getActiveHandlerCount()`
`int`	`getActiveReadHandlerCount()`
`int`	`getActiveScanHandlerCount()`
`int`	`getActiveWriteHandlerCount()`
`static RpcExecutor.QueueBalancer`	`getBalancer(int queueSize)`
`protected RpcExecutor.Handler`	`getHandler(String name, double handlerFailureThreshhold, BlockingQueue<CallRunner> q, AtomicInteger activeHandlerCount)` Override if providing alternate Handler implementation.
`String`	`getName()`
`long`	`getNumGeneralCallsDropped()`
`long`	`getNumLifoModeSwitches()`
`int`	`getQueueLength()` Returns the length of the pending queue
`List<BlockingQueue<CallRunner>>`	`getQueues()` Returns the list of request queues
`int`	`getReadQueueLength()`
`int`	`getScanQueueLength()`
`int`	`getWriteQueueLength()`
`protected void`	`initializeQueues(int numQueues)`
`static boolean`	`isCodelQueueType(String callQueueType)`
`static boolean`	`isDeadlineQueueType(String callQueueType)`
`static boolean`	`isFifoQueueType(String callQueueType)`
`void`	`onConfigurationChange(org.apache.hadoop.conf.Configuration conf)`
`void`	`resizeQueues(org.apache.hadoop.conf.Configuration conf)` Update current soft limit for executor's call queues
`void`	`start(int port)`
`protected void`	`startHandlers(int port)`
`protected void`	`startHandlers(String nameSuffix, int numHandlers, List<BlockingQueue<CallRunner>> callQueues, int qindex, int qsize, int port, AtomicInteger activeHandlerCount)` Start up our handlers.
`void`	`stop()`

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

Field Detail
- DEFAULT_CALL_QUEUE_SIZE_HARD_LIMIT
```
protected static final int DEFAULT_CALL_QUEUE_SIZE_HARD_LIMIT
```
  See Also:
  Constant Field Values
- CALL_QUEUE_HANDLER_FACTOR_CONF_KEY
```
public static final String CALL_QUEUE_HANDLER_FACTOR_CONF_KEY
```
  See Also:
  Constant Field Values
- QUEUE_MAX_CALL_DELAY_CONF_KEY
```
public static final String QUEUE_MAX_CALL_DELAY_CONF_KEY
```
  max delay in msec used to bound the deprioritized requests
  
  See Also:
  Constant Field Values
- CALL_QUEUE_TYPE_CODEL_CONF_VALUE
```
public static final String CALL_QUEUE_TYPE_CODEL_CONF_VALUE
```
  The default, 'fifo', has the least friction but is dumb. If set to 'deadline', uses a priority queue and deprioritizes long-running scans. Sorting by priority comes at a cost, reduced throughput.
  
  See Also:
  Constant Field Values
- CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE
```
public static final String CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE
```
  See Also:
  Constant Field Values
- CALL_QUEUE_TYPE_FIFO_CONF_VALUE
```
public static final String CALL_QUEUE_TYPE_FIFO_CONF_VALUE
```
  See Also:
  Constant Field Values
- CALL_QUEUE_TYPE_CONF_KEY
```
public static final String CALL_QUEUE_TYPE_CONF_KEY
```
  See Also:
  Constant Field Values
- CALL_QUEUE_TYPE_CONF_DEFAULT
```
public static final String CALL_QUEUE_TYPE_CONF_DEFAULT
```
  See Also:
  Constant Field Values
- CALL_QUEUE_CODEL_TARGET_DELAY
```
public static final String CALL_QUEUE_CODEL_TARGET_DELAY
```
  See Also:
  Constant Field Values
- CALL_QUEUE_CODEL_INTERVAL
```
public static final String CALL_QUEUE_CODEL_INTERVAL
```
  See Also:
  Constant Field Values
- CALL_QUEUE_CODEL_LIFO_THRESHOLD
```
public static final String CALL_QUEUE_CODEL_LIFO_THRESHOLD
```
  See Also:
  Constant Field Values
- CALL_QUEUE_CODEL_DEFAULT_TARGET_DELAY
```
public static final int CALL_QUEUE_CODEL_DEFAULT_TARGET_DELAY
```
  See Also:
  Constant Field Values
- CALL_QUEUE_CODEL_DEFAULT_INTERVAL
```
public static final int CALL_QUEUE_CODEL_DEFAULT_INTERVAL
```
  See Also:
  Constant Field Values
- CALL_QUEUE_CODEL_DEFAULT_LIFO_THRESHOLD
```
public static final double CALL_QUEUE_CODEL_DEFAULT_LIFO_THRESHOLD
```
  See Also:
  Constant Field Values
- numCallQueues
```
protected final int numCallQueues
```
- queues
```
protected final List<BlockingQueue<CallRunner>> queues
```
- currentQueueLimit
```
protected volatile int currentQueueLimit
```

Constructor Detail

RpcExecutor

@Deprecated
public RpcExecutor(String name,
                      int handlerCount,
                      int numCallQueues)

Deprecated.

RpcExecutor

@Deprecated
public RpcExecutor(String name,
                      int handlerCount,
                      int numCallQueues,
                      org.apache.hadoop.conf.Configuration conf,
                      Abortable abortable)

Deprecated.

RpcExecutor

public RpcExecutor(String name,
           int handlerCount,
           int maxQueueLength,
           PriorityFunction priority,
           org.apache.hadoop.conf.Configuration conf,
           Abortable abortable)

RpcExecutor

public RpcExecutor(String name,
           int handlerCount,
           String callQueueType,
           int maxQueueLength,
           PriorityFunction priority,
           org.apache.hadoop.conf.Configuration conf,
           Abortable abortable)

Method Detail

computeNumCallQueues

protected int computeNumCallQueues(int handlerCount,
                       float callQueuesHandlersFactor)

initializeQueues

protected void initializeQueues(int numQueues)

start
```
public void start(int port)
```

stop
```
public void stop()
```

dispatch

public abstract boolean dispatch(CallRunner callTask)
                          throws InterruptedException

Add the request to the executor queue

Throws:: InterruptedException

getQueues

public List<BlockingQueue<CallRunner>> getQueues()

Returns the list of request queues

startHandlers

protected void startHandlers(int port)

getHandler

protected RpcExecutor.Handler getHandler(String name,
                             double handlerFailureThreshhold,
                             BlockingQueue<CallRunner> q,
                             AtomicInteger activeHandlerCount)

Override if providing alternate Handler implementation.

startHandlers

protected void startHandlers(String nameSuffix,
                 int numHandlers,
                 List<BlockingQueue<CallRunner>> callQueues,
                 int qindex,
                 int qsize,
                 int port,
                 AtomicInteger activeHandlerCount)

Start up our handlers.

getBalancer

public static RpcExecutor.QueueBalancer getBalancer(int queueSize)

isDeadlineQueueType

public static boolean isDeadlineQueueType(String callQueueType)

isCodelQueueType

public static boolean isCodelQueueType(String callQueueType)

isFifoQueueType

public static boolean isFifoQueueType(String callQueueType)

getNumGeneralCallsDropped

public long getNumGeneralCallsDropped()

getNumLifoModeSwitches
```
public long getNumLifoModeSwitches()
```

getActiveHandlerCount
```
public int getActiveHandlerCount()
```

getActiveWriteHandlerCount

public int getActiveWriteHandlerCount()

getActiveReadHandlerCount

public int getActiveReadHandlerCount()

getActiveScanHandlerCount

public int getActiveScanHandlerCount()

getQueueLength
```
public int getQueueLength()
```
Returns the length of the pending queue

getReadQueueLength
```
public int getReadQueueLength()
```

getScanQueueLength
```
public int getScanQueueLength()
```

getWriteQueueLength
```
public int getWriteQueueLength()
```

getName
```
public String getName()
```

resizeQueues
```
public void resizeQueues(org.apache.hadoop.conf.Configuration conf)
```
Update current soft limit for executor's call queues

Parameters:
conf - updated configuration

onConfigurationChange

public void onConfigurationChange(org.apache.hadoop.conf.Configuration conf)

Class RpcExecutor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_CALL_QUEUE_SIZE_HARD_LIMIT

CALL_QUEUE_HANDLER_FACTOR_CONF_KEY

QUEUE_MAX_CALL_DELAY_CONF_KEY

CALL_QUEUE_TYPE_CODEL_CONF_VALUE

CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE

CALL_QUEUE_TYPE_FIFO_CONF_VALUE

CALL_QUEUE_TYPE_CONF_KEY

CALL_QUEUE_TYPE_CONF_DEFAULT

CALL_QUEUE_CODEL_TARGET_DELAY

CALL_QUEUE_CODEL_INTERVAL

CALL_QUEUE_CODEL_LIFO_THRESHOLD

CALL_QUEUE_CODEL_DEFAULT_TARGET_DELAY

CALL_QUEUE_CODEL_DEFAULT_INTERVAL

CALL_QUEUE_CODEL_DEFAULT_LIFO_THRESHOLD

numCallQueues

queues

currentQueueLimit

Constructor Detail

RpcExecutor

RpcExecutor

RpcExecutor

RpcExecutor

Method Detail

computeNumCallQueues

initializeQueues

start

stop

dispatch

getQueues

startHandlers

getHandler

startHandlers

getBalancer

isDeadlineQueueType

isCodelQueueType

isFifoQueueType

getNumGeneralCallsDropped

getNumLifoModeSwitches

getActiveHandlerCount

getActiveWriteHandlerCount

getActiveReadHandlerCount

getActiveScanHandlerCount

getQueueLength

getReadQueueLength

getScanQueueLength

getWriteQueueLength

getName

resizeQueues

onConfigurationChange