1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase.monitoring;
20  
21  import org.apache.hadoop.classification.InterfaceAudience;
22  
23  import com.google.protobuf.Message;
24  
25  /**
26   * A MonitoredTask implementation optimized for use with RPC Handlers 
27   * handling frequent, short duration tasks. String concatenations and object 
28   * allocations are avoided in methods that will be hit by every RPC call.
29   */
30  @InterfaceAudience.Private
31  public interface MonitoredRPCHandler extends MonitoredTask {
32    public abstract String getRPC();
33    public abstract String getRPC(boolean withParams);
34    public abstract long getRPCPacketLength();
35    public abstract String getClient();
36    public abstract long getRPCStartTime();
37    public abstract long getRPCQueueTime();
38    public abstract boolean isRPCRunning();
39    public abstract boolean isOperationRunning();
40  
41    public abstract void setRPC(String methodName, Object [] params, long queueTime);
42    public abstract void setRPCPacket(Message param);
43    public abstract void setConnection(String clientAddress, int remotePort);
44  }