RpcScheduler (Apache HBase 2.3.0 API)

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

Direct Known Subclasses:: FifoRpcScheduler, SimpleRpcScheduler

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

An interface for RPC request scheduling algorithm.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RpcScheduler.Context
Exposes runtime information of a RpcServer that a RpcScheduler may need.

Nested Classes
Modifier and Type	Class and Description
`static class`	`RpcScheduler.Context` Exposes runtime information of a `RpcServer` that a `RpcScheduler` may need.

Field Summary

Fields
Modifier and Type Field and Description

static String IPC_SERVER_MAX_CALLQUEUE_LENGTH

static String IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH

Fields
Modifier and Type	Field and Description
`static String`	`IPC_SERVER_MAX_CALLQUEUE_LENGTH`
`static String`	`IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH`

Constructor Summary

Constructors
Constructor and Description

RpcScheduler()

Constructors
Constructor and Description
`RpcScheduler()`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`abstract boolean`	`dispatch(CallRunner task)` Dispatches an RPC request asynchronously.
`abstract int`	`getActiveGeneralRpcHandlerCount()` Retrieves the number of active general handler.
`abstract int`	`getActiveMetaPriorityRpcHandlerCount()` Retrieves the number of active meta priority handler.
`abstract int`	`getActivePriorityRpcHandlerCount()` Retrieves the number of active priority handler.
`abstract int`	`getActiveReadRpcHandlerCount()` Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.
`abstract int`	`getActiveReplicationRpcHandlerCount()` Retrieves the number of active replication handler.
`abstract int`	`getActiveRpcHandlerCount()` Retrieves the total number of active handler.
`abstract int`	`getActiveScanRpcHandlerCount()` Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.
`abstract int`	`getActiveWriteRpcHandlerCount()` Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.
`abstract CallQueueInfo`	`getCallQueueInfo()` Get call queue information
`abstract int`	`getGeneralQueueLength()` Retrieves length of the general queue for metrics.
`abstract int`	`getMetaPriorityQueueLength()` Retrieves length of the meta priority queue for metrics.
`abstract long`	`getNumGeneralCallsDropped()` If CoDel-based RPC executors are used, retrieves the number of Calls that were dropped from general queue because RPC executor is under high load; returns 0 otherwise.
`abstract long`	`getNumLifoModeSwitches()` If CoDel-based RPC executors are used, retrieves the number of Calls that were picked from the tail of the queue (indicating adaptive LIFO mode, when in the period of overloade we serve last requests first); returns 0 otherwise.
`abstract int`	`getPriorityQueueLength()` Retrieves length of the priority queue for metrics.
`abstract int`	`getReadQueueLength()` Retrieves length of the read queue for metrics when use RWQueueRpcExecutor.
`abstract int`	`getReplicationQueueLength()` Retrieves length of the replication queue for metrics.
`abstract int`	`getScanQueueLength()` Retrieves length of the scan queue for metrics when use RWQueueRpcExecutor.
`abstract int`	`getWriteQueueLength()` Retrieves length of the write queue for metrics when use RWQueueRpcExecutor.
`abstract void`	`init(RpcScheduler.Context context)` Does some quick initialization.
`abstract void`	`start()` Prepares for request serving.
`abstract 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
  - IPC_SERVER_MAX_CALLQUEUE_LENGTH
```
public static final String IPC_SERVER_MAX_CALLQUEUE_LENGTH
```
    See Also:
    
    Constant Field Values
  - IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH
```
public static final String IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - RpcScheduler
```
public RpcScheduler()
```
- Method Detail
  - init
```
public abstract void init(RpcScheduler.Context context)
```
    Does some quick initialization. Heavy tasks (e.g. starting threads) should be done in start(). This method is called before start.
    
    Parameters:
    
    context - provides methods to retrieve runtime information from
  - start
```
public abstract void start()
```
    Prepares for request serving. An implementation may start some handler threads here.
  - stop
```
public abstract void stop()
```
    Stops serving new requests.
  - dispatch
```
public abstract boolean dispatch(CallRunner task)
                          throws IOException,
                                 InterruptedException
```
    Dispatches an RPC request asynchronously. An implementation is free to choose to process the request immediately or delay it for later processing.
    
    Parameters:
    
    task - the request to be dispatched
    
    Throws:
    
    IOException
    
    InterruptedException
  - getCallQueueInfo
```
public abstract CallQueueInfo getCallQueueInfo()
```
    Get call queue information
  - getGeneralQueueLength
```
public abstract int getGeneralQueueLength()
```
    Retrieves length of the general queue for metrics.
  - getPriorityQueueLength
```
public abstract int getPriorityQueueLength()
```
    Retrieves length of the priority queue for metrics.
  - getMetaPriorityQueueLength
```
public abstract int getMetaPriorityQueueLength()
```
    Retrieves length of the meta priority queue for metrics.
  - getReplicationQueueLength
```
public abstract int getReplicationQueueLength()
```
    Retrieves length of the replication queue for metrics.
  - getActiveRpcHandlerCount
```
public abstract int getActiveRpcHandlerCount()
```
    Retrieves the total number of active handler.
  - getActiveGeneralRpcHandlerCount
```
public abstract int getActiveGeneralRpcHandlerCount()
```
    Retrieves the number of active general handler.
  - getActivePriorityRpcHandlerCount
```
public abstract int getActivePriorityRpcHandlerCount()
```
    Retrieves the number of active priority handler.
  - getActiveMetaPriorityRpcHandlerCount
```
public abstract int getActiveMetaPriorityRpcHandlerCount()
```
    Retrieves the number of active meta priority handler.
  - getActiveReplicationRpcHandlerCount
```
public abstract int getActiveReplicationRpcHandlerCount()
```
    Retrieves the number of active replication handler.
  - getNumGeneralCallsDropped
```
public abstract long getNumGeneralCallsDropped()
```
    If CoDel-based RPC executors are used, retrieves the number of Calls that were dropped from general queue because RPC executor is under high load; returns 0 otherwise.
  - getNumLifoModeSwitches
```
public abstract long getNumLifoModeSwitches()
```
    If CoDel-based RPC executors are used, retrieves the number of Calls that were picked from the tail of the queue (indicating adaptive LIFO mode, when in the period of overloade we serve last requests first); returns 0 otherwise.
  - getWriteQueueLength
```
public abstract int getWriteQueueLength()
```
    Retrieves length of the write queue for metrics when use RWQueueRpcExecutor.
  - getReadQueueLength
```
public abstract int getReadQueueLength()
```
    Retrieves length of the read queue for metrics when use RWQueueRpcExecutor.
  - getScanQueueLength
```
public abstract int getScanQueueLength()
```
    Retrieves length of the scan queue for metrics when use RWQueueRpcExecutor.
  - getActiveWriteRpcHandlerCount
```
public abstract int getActiveWriteRpcHandlerCount()
```
    Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.
  - getActiveReadRpcHandlerCount
```
public abstract int getActiveReadRpcHandlerCount()
```
    Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.
  - getActiveScanRpcHandlerCount
```
public abstract int getActiveScanRpcHandlerCount()
```
    Retrieves the number of active write rpc handler when use RWQueueRpcExecutor.

Class RpcScheduler

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IPC_SERVER_MAX_CALLQUEUE_LENGTH

IPC_SERVER_PRIORITY_MAX_CALLQUEUE_LENGTH

Constructor Detail

RpcScheduler

Method Detail

init

start

stop

dispatch

getCallQueueInfo

getGeneralQueueLength

getPriorityQueueLength

getMetaPriorityQueueLength

getReplicationQueueLength

getActiveRpcHandlerCount

getActiveGeneralRpcHandlerCount

getActivePriorityRpcHandlerCount

getActiveMetaPriorityRpcHandlerCount

getActiveReplicationRpcHandlerCount

getNumGeneralCallsDropped

getNumLifoModeSwitches

getWriteQueueLength

getReadQueueLength

getScanQueueLength

getActiveWriteRpcHandlerCount

getActiveReadRpcHandlerCount

getActiveScanRpcHandlerCount