1 /** 2 * Licensed to the Apache Software Foundation (ASF) under one 3 * or more contributor license agreements. See the NOTICE file 4 * distributed with this work for additional information 5 * regarding copyright ownership. The ASF licenses this file 6 * to you under the Apache License, Version 2.0 (the 7 * "License"); you may not use this file except in compliance 8 * with the License. You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 package org.apache.hadoop.hbase.ipc; 19 20 import com.google.protobuf.Message; 21 import org.apache.hadoop.hbase.classification.InterfaceAudience; 22 import org.apache.hadoop.hbase.classification.InterfaceStability; 23 import org.apache.hadoop.hbase.HBaseInterfaceAudience; 24 import org.apache.hadoop.hbase.protobuf.generated.RPCProtos.RequestHeader; 25 26 /** 27 * Function to figure priority of incoming request. 28 */ 29 @InterfaceAudience.LimitedPrivate({HBaseInterfaceAudience.COPROC, HBaseInterfaceAudience.PHOENIX}) 30 @InterfaceStability.Evolving 31 public interface PriorityFunction { 32 /** 33 * Returns the 'priority type' of the specified request. 34 * The returned value is mainly used to select the dispatch queue. 35 * @param header 36 * @param param 37 * @return Priority of this request. 38 */ 39 int getPriority(RequestHeader header, Message param); 40 41 /** 42 * Returns the deadline of the specified request. 43 * The returned value is used to sort the dispatch queue. 44 * @param header 45 * @param param 46 * @return Deadline of this request. 0 now, otherwise msec of 'delay' 47 */ 48 long getDeadline(RequestHeader header, Message param); 49 }