michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib;
michael@0: 
michael@0: /**
michael@0:  * The point of access to the statistics of an {@link HttpConnection}.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface HttpConnectionMetrics {
michael@0: 
michael@0:     /**
michael@0:      * Returns the number of requests transferred over the connection,
michael@0:      * 0 if not available.
michael@0:      */
michael@0:     long getRequestCount();
michael@0: 
michael@0:     /**
michael@0:      * Returns the number of responses transferred over the connection,
michael@0:      * 0 if not available.
michael@0:      */
michael@0:     long getResponseCount();
michael@0: 
michael@0:     /**
michael@0:      * Returns the number of bytes transferred over the connection,
michael@0:      * 0 if not available.
michael@0:      */
michael@0:     long getSentBytesCount();
michael@0: 
michael@0:     /**
michael@0:      * Returns the number of bytes transferred over the connection,
michael@0:      * 0 if not available.
michael@0:      */
michael@0:     long getReceivedBytesCount();
michael@0: 
michael@0:     /**
michael@0:      * Return the value for the specified metric.
michael@0:      *
michael@0:      *@param metricName the name of the metric to query.
michael@0:      *
michael@0:      *@return the object representing the metric requested,
michael@0:      *        <code>null</code> if the metric cannot not found.
michael@0:      */
michael@0:     Object getMetric(String metricName);
michael@0: 
michael@0:     /**
michael@0:      * Resets the counts
michael@0:      *
michael@0:      */
michael@0:     void reset();
michael@0: 
michael@0: }