org.apache.hadoop.hbase.regionserver

Class AnnotationReadingPriorityFunction

java.lang.Object

org.apache.hadoop.hbase.regionserver.AnnotationReadingPriorityFunction

All Implemented Interfaces:

PriorityFunction

Direct Known Subclasses:

MasterAnnotationReadingPriorityFunction

public class AnnotationReadingPriorityFunction
extends java.lang.Object
implements PriorityFunction

Reads special method annotations and table names to figure a priority for use by QoS facility in ipc; e.g: rpcs to hbase:meta get priority.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.Integer>	annotatedQos
static java.lang.String	SCAN_VTIME_WEIGHT_CONF_KEY Used to control the scan delay, currently sqrt(numNextCall * weight)

Constructor Summary

Constructors

Constructor and Description
AnnotationReadingPriorityFunction(RSRpcServices rpcServices) Calls AnnotationReadingPriorityFunction(RSRpcServices, Class) using the result of rpcServices#getClass()
AnnotationReadingPriorityFunction(RSRpcServices rpcServices, java.lang.Class<? extends RSRpcServices> clz) Constructs the priority function given the RPC server implementation and the annotations on the methods in the provided clz.

Method Summary

Modifier and Type	Method and Description
protected int	getAnnotatedPriority(RequestHeader header) See if the method has an annotation.
protected int	getBasePriority(RequestHeader header, Message param) Get the priority for a given request from the header and the param This doesn't consider which user is sending the request at all.
long	getDeadline(RequestHeader header, Message param) Based on the request content, returns the deadline of the request.
int	getPriority(RequestHeader header, Message param, User user) Returns a 'priority' based on the request type.

Methods inherited from class java.lang.Object

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

Field Detail

SCAN_VTIME_WEIGHT_CONF_KEY

public static final java.lang.String SCAN_VTIME_WEIGHT_CONF_KEY

Used to control the scan delay, currently sqrt(numNextCall * weight)

See Also:

Constant Field Values

annotatedQos

protected final java.util.Map<java.lang.String,java.lang.Integer> annotatedQos

Constructor Detail

AnnotationReadingPriorityFunction

public AnnotationReadingPriorityFunction(RSRpcServices rpcServices)

Calls AnnotationReadingPriorityFunction(RSRpcServices, Class) using the result of rpcServices#getClass()

Parameters:

rpcServices - The RPC server implementation

AnnotationReadingPriorityFunction

public AnnotationReadingPriorityFunction(RSRpcServices rpcServices,
                                         java.lang.Class<? extends RSRpcServices> clz)

Constructs the priority function given the RPC server implementation and the annotations on the methods in the provided clz.

Parameters:

rpcServices - The RPC server implementation

clz - The concrete RPC server implementation's class

Method Detail

getPriority

public int getPriority(RequestHeader header,
                       Message param,
                       User user)

Returns a 'priority' based on the request type. Currently the returned priority is used for queue selection. See the SimpleRpcScheduler as example. It maintains a queue per 'priory type' HIGH_QOS (meta requests), REPLICATION_QOS (replication requests), NORMAL_QOS (user requests).

Specified by:

getPriority in interface PriorityFunction

Returns:

Priority of this request.

getAnnotatedPriority

protected int getAnnotatedPriority(RequestHeader header)

See if the method has an annotation.

Parameters:

header -

Returns:

Return the priority from the annotation. If there isn't an annotation, this returns something below zero.

getBasePriority

protected int getBasePriority(RequestHeader header,
                              Message param)

Get the priority for a given request from the header and the param This doesn't consider which user is sending the request at all. This doesn't consider annotations

getDeadline

public long getDeadline(RequestHeader header,
                        Message param)

Based on the request content, returns the deadline of the request.

Specified by:

getDeadline in interface PriorityFunction

Parameters:

header -

param -

Returns:

Deadline of this request. 0 now, otherwise msec of 'delay'