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: package ch.boye.httpclientandroidlib.conn;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.ConnectionReuseStrategy;
michael@0: import ch.boye.httpclientandroidlib.HttpResponse;
michael@0: import ch.boye.httpclientandroidlib.protocol.HttpContext;
michael@0: 
michael@0: /**
michael@0:  * Interface for deciding how long a connection can remain
michael@0:  * idle before being reused.
michael@0:  * <p>
michael@0:  * Implementations of this interface must be thread-safe. Access to shared
michael@0:  * data must be synchronized as methods of this interface may be executed
michael@0:  * from multiple threads.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface ConnectionKeepAliveStrategy {
michael@0: 
michael@0:     /**
michael@0:      * Returns the duration of time which this connection can be safely kept
michael@0:      * idle. If the connection is left idle for longer than this period of time,
michael@0:      * it MUST not reused. A value of 0 or less may be returned to indicate that
michael@0:      * there is no suitable suggestion.
michael@0:      *
michael@0:      * When coupled with a {@link ConnectionReuseStrategy}, if
michael@0:      * {@link ConnectionReuseStrategy#keepAlive(HttpResponse, HttpContext)}
michael@0:      * returns true, this allows you to control how long the reuse will last. If
michael@0:      * keepAlive returns false, this should have no meaningful impact
michael@0:      *
michael@0:      * @param response
michael@0:      *            The last response received over the connection.
michael@0:      * @param context
michael@0:      *            the context in which the connection is being used.
michael@0:      *
michael@0:      * @return the duration in ms for which it is safe to keep the connection
michael@0:      *         idle, or <=0 if no suggested duration.
michael@0:      */
michael@0:     long getKeepAliveDuration(HttpResponse response, HttpContext context);
michael@0: 
michael@0: }