org.apache.hadoop.hbase.ipc

Interface RpcScheduler

All Known Implementing Classes:

FifoRpcScheduler, SimpleRpcScheduler

@InterfaceAudience.Private
@InterfaceStability.Evolving
public interface RpcScheduler

An interface for RPC request scheduling algorithm.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RpcScheduler.Context Exposes runtime information of a RpcServer that a RpcScheduler may need.

Method Summary

Methods

Modifier and Type	Method and Description
void	dispatch(CallRunner task) Dispatches an RPC request asynchronously.
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.

Method Detail

init

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

void start()

Prepares for request serving. An implementation may start some handler threads here.

stop

void stop()

Stops serving new requests.

dispatch

void 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

getGeneralQueueLength

int getGeneralQueueLength()

Retrieves length of the general queue for metrics.

getPriorityQueueLength

int getPriorityQueueLength()

Retrieves length of the priority queue for metrics.

getReplicationQueueLength

int getReplicationQueueLength()

Retrieves length of the replication queue for metrics.