001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http;
029
030/**
031 * The point of access to the statistics of an {@link HttpConnection}.
032 *
033 * @since 4.0
034 */
035public interface HttpConnectionMetrics {
036
037    /**
038     * Returns the number of requests transferred over the connection,
039     * 0 if not available.
040     */
041    long getRequestCount();
042
043    /**
044     * Returns the number of responses transferred over the connection,
045     * 0 if not available.
046     */
047    long getResponseCount();
048
049    /**
050     * Returns the number of bytes transferred over the connection,
051     * 0 if not available.
052     */
053    long getSentBytesCount();
054
055    /**
056     * Returns the number of bytes transferred over the connection,
057     * 0 if not available.
058     */
059    long getReceivedBytesCount();
060
061    /**
062     * Return the value for the specified metric.
063     *
064     *@param metricName the name of the metric to query.
065     *
066     *@return the object representing the metric requested,
067     *        {@code null} if the metric cannot not found.
068     */
069    Object getMetric(String metricName);
070
071    /**
072     * Resets the counts
073     *
074     */
075    void reset();
076
077}