1/*
2 * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/HttpConnectionMetrics.java $
3 * $Revision: 548035 $
4 * $Date: 2007-06-17 05:17:03 -0700 (Sun, 17 Jun 2007) $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31
32package org.apache.http;
33
34/**
35 * The point of access to the statistics of an {@link HttpConnection}.
36 */
37public interface HttpConnectionMetrics {
38
39    /**
40     * Returns the number of requests transferred over the connection,
41     * 0 if not available.
42     */
43    long getRequestCount();
44
45    /**
46     * Returns the number of responses transferred over the connection,
47     * 0 if not available.
48     */
49    long getResponseCount();
50
51    /**
52     * Returns the number of bytes transferred over the connection,
53     * 0 if not available.
54     */
55    long getSentBytesCount();
56
57    /**
58     * Returns the number of bytes transferred over the connection,
59     * 0 if not available.
60     */
61    long getReceivedBytesCount();
62
63    /**
64     * Return the value for the specified metric.
65     *
66     *@param metricName the name of the metric to query.
67     *
68     *@return the object representing the metric requested,
69     *        <code>null</code> if the metric cannot not found.
70     */
71    Object getMetric(String metricName);
72
73    /**
74     * Resets the counts
75     *
76     */
77    void reset();
78
79}
80