View Javadoc

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,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http;
29  
30  /**
31   * The point of access to the statistics of an {@link HttpConnection}.
32   *
33   * @since 4.0
34   */
35  public interface HttpConnectionMetrics {
36  
37      /**
38       * Returns the number of requests transferred over the connection,
39       * 0 if not available.
40       */
41      long getRequestCount();
42  
43      /**
44       * Returns the number of responses transferred over the connection,
45       * 0 if not available.
46       */
47      long getResponseCount();
48  
49      /**
50       * Returns the number of bytes transferred over the connection,
51       * 0 if not available.
52       */
53      long getSentBytesCount();
54  
55      /**
56       * Returns the number of bytes transferred over the connection,
57       * 0 if not available.
58       */
59      long getReceivedBytesCount();
60  
61      /**
62       * Return the value for the specified metric.
63       *
64       *@param metricName the name of the metric to query.
65       *
66       *@return the object representing the metric requested,
67       *        {@code null} if the metric cannot not found.
68       */
69      Object getMetric(String metricName);
70  
71      /**
72       * Resets the counts
73       *
74       */
75      void reset();
76  
77  }