View Javadoc

1   /**
2    * Copyright 2011 The Apache Software Foundation
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   *     http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing, software
15   * distributed under the License is distributed on an "AS IS" BASIS,
16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17   * See the License for the specific language governing permissions and
18   * limitations under the License.
19   */
20  package org.apache.hadoop.hbase.monitoring;
21  
22  import org.apache.hadoop.hbase.util.Bytes;
23  import org.apache.hadoop.io.Writable;
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  public interface MonitoredRPCHandler extends MonitoredTask {
31    public abstract String getRPC();
32    public abstract String getRPC(boolean withParams);
33    public abstract long getRPCPacketLength();
34    public abstract String getClient();
35    public abstract long getRPCStartTime();
36    public abstract long getRPCQueueTime();
37    public abstract boolean isRPCRunning();
38    public abstract boolean isOperationRunning();
39    
40    public abstract void setRPC(String methodName, Object [] params,
41        long queueTime);
42    public abstract void setRPCPacket(Writable param);
43    public abstract void setConnection(String clientAddress, int remotePort);
44  }