SimpleRpcScheduler (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.ipc.RpcScheduler
- - org.apache.hadoop.hbase.ipc.SimpleRpcScheduler

@InterfaceAudience.LimitedPrivate(value={"Coprocesssor","Phoenix"})
@InterfaceStability.Evolving
public class SimpleRpcScheduler
extends RpcScheduler

A scheduler that maintains isolated handler pools for general, high-priority, and replication requests.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`private static class`	`SimpleRpcScheduler.CallPriorityComparator` Comparator used by the "normal callQueue" if DEADLINE_CALL_QUEUE_CONF_KEY is set to true.

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.ipc.RpcScheduler
RpcScheduler.Context

Field Summary

Fields
Modifier and Type	Field and Description
`private Abortable`	`abortable`
`static String`	`CALL_QUEUE_HANDLER_FACTOR_CONF_KEY`
`static String`	`CALL_QUEUE_READ_SHARE_CONF_KEY`
`static String`	`CALL_QUEUE_SCAN_SHARE_CONF_KEY`
`static String`	`CALL_QUEUE_TYPE_CONF_KEY` If set to 'deadline', uses a priority queue and deprioritize long-running scans
`static String`	`CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE`
`static String`	`CALL_QUEUE_TYPE_FIFO_CONF_VALUE`
`private RpcExecutor`	`callExecutor`
`private int`	`highPriorityLevel` What level a high priority call is at.
`private static org.apache.commons.logging.Log`	`LOG`
`private int`	`port`
`private PriorityFunction`	`priority`
`private RpcExecutor`	`priorityExecutor`
`static String`	`QUEUE_MAX_CALL_DELAY_CONF_KEY` max delay in msec used to bound the deprioritized requests
`private RpcExecutor`	`replicationExecutor`

Constructor Summary

Constructors
Constructor and Description
`SimpleRpcScheduler(org.apache.hadoop.conf.Configuration conf, int handlerCount, int priorityHandlerCount, int replicationHandlerCount, PriorityFunction priority, Abortable server, int highPriorityLevel)`
`SimpleRpcScheduler(org.apache.hadoop.conf.Configuration conf, int handlerCount, int priorityHandlerCount, int replicationHandlerCount, PriorityFunction priority, int highPriorityLevel)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`dispatch(CallRunner callTask)` Dispatches an RPC request asynchronously.
`int`	`getActiveRpcHandlerCount()` Retrieves the number of active handler.
`int`	`getGeneralQueueLength()` Retrieves length of the general queue for metrics.
`int`	`getPriorityQueueLength()` Retrieves length of the priority queue for metrics.
`int`	`getReplicationQueueLength()` Retrieves length of the replication queue for metrics.
`void`	`init(RpcScheduler.Context context)` Does some quick initialization.
`void`	`start()` Prepares for request serving.
`void`	`stop()` Stops serving new requests.

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

- Field Detail
  - LOG
```
private static final org.apache.commons.logging.Log LOG
```
  - CALL_QUEUE_READ_SHARE_CONF_KEY
```
public static final String CALL_QUEUE_READ_SHARE_CONF_KEY
```
    See Also:
    Constant Field Values
  - CALL_QUEUE_SCAN_SHARE_CONF_KEY
```
public static final String CALL_QUEUE_SCAN_SHARE_CONF_KEY
```
    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
  - CALL_QUEUE_TYPE_CONF_KEY
```
public static final String CALL_QUEUE_TYPE_CONF_KEY
```
    If set to 'deadline', uses a priority queue and deprioritize long-running scans
    
    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
  - 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
  - port
```
private int port
```
  - priority
```
private final PriorityFunction priority
```
  - callExecutor
```
private final RpcExecutor callExecutor
```
  - priorityExecutor
```
private final RpcExecutor priorityExecutor
```
  - replicationExecutor
```
private final RpcExecutor replicationExecutor
```
  - highPriorityLevel
```
private final int highPriorityLevel
```
    What level a high priority call is at.
  - abortable
```
private Abortable abortable
```
- Constructor Detail
  - SimpleRpcScheduler
```
public SimpleRpcScheduler(org.apache.hadoop.conf.Configuration conf,
                  int handlerCount,
                  int priorityHandlerCount,
                  int replicationHandlerCount,
                  PriorityFunction priority,
                  Abortable server,
                  int highPriorityLevel)
```
    Parameters:
    conf -
    handlerCount - the number of handler threads that will be used to process calls
    priorityHandlerCount - How many threads for priority handling.
    replicationHandlerCount - How many threads for replication handling.
    highPriorityLevel -
    priority - Function to extract request priority.
  - SimpleRpcScheduler
```
public SimpleRpcScheduler(org.apache.hadoop.conf.Configuration conf,
                  int handlerCount,
                  int priorityHandlerCount,
                  int replicationHandlerCount,
                  PriorityFunction priority,
                  int highPriorityLevel)
```
- Method Detail
  - init
```
public void init(RpcScheduler.Context context)
```
    Description copied from class: RpcScheduler
    
    Does some quick initialization. Heavy tasks (e.g. starting threads) should be done in RpcScheduler.start(). This method is called before start.
    
    Specified by:
    
    init in class RpcScheduler
    
    Parameters:
    context - provides methods to retrieve runtime information from
  - start
```
public void start()
```
    Description copied from class: RpcScheduler
    
    Prepares for request serving. An implementation may start some handler threads here.
    
    Specified by:
    
    start in class RpcScheduler
  - stop
```
public void stop()
```
    Description copied from class: RpcScheduler
    
    Stops serving new requests.
    
    Specified by:
    
    stop in class RpcScheduler
  - dispatch
```
public boolean dispatch(CallRunner callTask)
                 throws InterruptedException
```
    Description copied from class: RpcScheduler
    
    Dispatches an RPC request asynchronously. An implementation is free to choose to process the request immediately or delay it for later processing.
    
    Specified by:
    
    dispatch in class RpcScheduler
    
    Parameters:
    callTask - the request to be dispatched
    
    Throws:
    
    InterruptedException
  - getGeneralQueueLength
```
public int getGeneralQueueLength()
```
    Description copied from class: RpcScheduler
    
    Retrieves length of the general queue for metrics.
    
    Specified by:
    
    getGeneralQueueLength in class RpcScheduler
  - getPriorityQueueLength
```
public int getPriorityQueueLength()
```
    Description copied from class: RpcScheduler
    
    Retrieves length of the priority queue for metrics.
    
    Specified by:
    
    getPriorityQueueLength in class RpcScheduler
  - getReplicationQueueLength
```
public int getReplicationQueueLength()
```
    Description copied from class: RpcScheduler
    
    Retrieves length of the replication queue for metrics.
    
    Specified by:
    
    getReplicationQueueLength in class RpcScheduler
  - getActiveRpcHandlerCount
```
public int getActiveRpcHandlerCount()
```
    Description copied from class: RpcScheduler
    
    Retrieves the number of active handler.
    
    Specified by:
    
    getActiveRpcHandlerCount in class RpcScheduler

Class SimpleRpcScheduler

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.ipc.RpcScheduler

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

CALL_QUEUE_READ_SHARE_CONF_KEY

CALL_QUEUE_SCAN_SHARE_CONF_KEY

CALL_QUEUE_HANDLER_FACTOR_CONF_KEY

CALL_QUEUE_TYPE_CONF_KEY

CALL_QUEUE_TYPE_DEADLINE_CONF_VALUE

CALL_QUEUE_TYPE_FIFO_CONF_VALUE

QUEUE_MAX_CALL_DELAY_CONF_KEY

port

priority

callExecutor

priorityExecutor

replicationExecutor

highPriorityLevel

abortable

Constructor Detail

SimpleRpcScheduler

SimpleRpcScheduler

Method Detail

init

start

stop

dispatch

getGeneralQueueLength

getPriorityQueueLength

getReplicationQueueLength

getActiveRpcHandlerCount