AnnotationReadingPriorityFunction (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.regionserver.AnnotationReadingPriorityFunction

All Implemented Interfaces:

PriorityFunction

Direct Known Subclasses:

MasterAnnotationReadingPriorityFunction
```
@InterfaceAudience.Private
public class AnnotationReadingPriorityFunction
extends 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 Map<String,Integer>`	`annotatedQos`
`private Map<String,Class<? extends com.google.protobuf.Message>>`	`argumentToClassMap`
`private Class<? extends com.google.protobuf.Message>[]`	`knownArgumentClasses`
`private static org.apache.commons.logging.Log`	`LOG`
`private Map<String,Map<Class<? extends com.google.protobuf.Message>,Method>>`	`methodMap`
`private RSRpcServices`	`rpcServices`
`static String`	`SCAN_VTIME_WEIGHT_CONF_KEY` Used to control the scan delay, currently sqrt(numNextCall * weight)
`private float`	`scanVirtualTimeWeight`

Constructor Summary

Constructors
Constructor and Description
`AnnotationReadingPriorityFunction(RSRpcServices rpcServices)` Calls `AnnotationReadingPriorityFunction(RSRpcServices, Class)` using the result of `rpcServices#getClass()`
`AnnotationReadingPriorityFunction(RSRpcServices rpcServices, 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

Methods
Modifier and Type	Method and Description
`private String`	`capitalize(String s)`
`protected int`	`getAnnotatedPriority(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header)` See if the method has an annotation.
`protected int`	`getBasePriority(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header, com.google.protobuf.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(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header, com.google.protobuf.Message param)` Based on the request content, returns the deadline of the request.
`int`	`getPriority(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header, com.google.protobuf.Message param, User user)` Returns a 'priority' based on the request type.
`(package private) void`	`setRegionServer(HRegionServer hrs)`

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
```
  - SCAN_VTIME_WEIGHT_CONF_KEY
```
public static final String SCAN_VTIME_WEIGHT_CONF_KEY
```
    Used to control the scan delay, currently sqrt(numNextCall * weight)
    
    See Also:
    Constant Field Values
  - annotatedQos
```
protected final Map<String,Integer> annotatedQos
```
  - rpcServices
```
private RSRpcServices rpcServices
```
  - knownArgumentClasses
```
private final Class<? extends com.google.protobuf.Message>[] knownArgumentClasses
```
  - argumentToClassMap
```
private final Map<String,Class<? extends com.google.protobuf.Message>> argumentToClassMap
```
  - methodMap
```
private final Map<String,Map<Class<? extends com.google.protobuf.Message>,Method>> methodMap
```
  - scanVirtualTimeWeight
```
private final float scanVirtualTimeWeight
```
- 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,
                                 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
  - capitalize
```
private String capitalize(String s)
```
  - getPriority
```
public int getPriority(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header,
              com.google.protobuf.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(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.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(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header,
                  com.google.protobuf.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(org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader header,
               com.google.protobuf.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'
  - setRegionServer
```
void setRegionServer(HRegionServer hrs)
```

Class AnnotationReadingPriorityFunction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

SCAN_VTIME_WEIGHT_CONF_KEY

annotatedQos

rpcServices

knownArgumentClasses

argumentToClassMap

methodMap

scanVirtualTimeWeight

Constructor Detail

AnnotationReadingPriorityFunction

AnnotationReadingPriorityFunction

Method Detail

capitalize

getPriority

getAnnotatedPriority

getBasePriority

getDeadline

setRegionServer