mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ConnectionKeepAliveStrategy.java

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ConnectionKeepAliveStrategy.java	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,66 @@
     1.4 +/*
     1.5 + * ====================================================================
     1.6 + * Licensed to the Apache Software Foundation (ASF) under one
     1.7 + * or more contributor license agreements.  See the NOTICE file
     1.8 + * distributed with this work for additional information
     1.9 + * regarding copyright ownership.  The ASF licenses this file
    1.10 + * to you under the Apache License, Version 2.0 (the
    1.11 + * "License"); you may not use this file except in compliance
    1.12 + * with the License.  You may obtain a copy of the License at
    1.13 + *
    1.14 + *   http://www.apache.org/licenses/LICENSE-2.0
    1.15 + *
    1.16 + * Unless required by applicable law or agreed to in writing,
    1.17 + * software distributed under the License is distributed on an
    1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    1.19 + * KIND, either express or implied.  See the License for the
    1.20 + * specific language governing permissions and limitations
    1.21 + * under the License.
    1.22 + * ====================================================================
    1.23 + *
    1.24 + * This software consists of voluntary contributions made by many
    1.25 + * individuals on behalf of the Apache Software Foundation.  For more
    1.26 + * information on the Apache Software Foundation, please see
    1.27 + * <http://www.apache.org/>.
    1.28 + *
    1.29 + */
    1.30 +package ch.boye.httpclientandroidlib.conn;
    1.31 +
    1.32 +import ch.boye.httpclientandroidlib.ConnectionReuseStrategy;
    1.33 +import ch.boye.httpclientandroidlib.HttpResponse;
    1.34 +import ch.boye.httpclientandroidlib.protocol.HttpContext;
    1.35 +
    1.36 +/**
    1.37 + * Interface for deciding how long a connection can remain
    1.38 + * idle before being reused.
    1.39 + * <p>
    1.40 + * Implementations of this interface must be thread-safe. Access to shared
    1.41 + * data must be synchronized as methods of this interface may be executed
    1.42 + * from multiple threads.
    1.43 + *
    1.44 + * @since 4.0
    1.45 + */
    1.46 +public interface ConnectionKeepAliveStrategy {
    1.47 +
    1.48 +    /**
    1.49 +     * Returns the duration of time which this connection can be safely kept
    1.50 +     * idle. If the connection is left idle for longer than this period of time,
    1.51 +     * it MUST not reused. A value of 0 or less may be returned to indicate that
    1.52 +     * there is no suitable suggestion.
    1.53 +     *
    1.54 +     * When coupled with a {@link ConnectionReuseStrategy}, if
    1.55 +     * {@link ConnectionReuseStrategy#keepAlive(HttpResponse, HttpContext)}
    1.56 +     * returns true, this allows you to control how long the reuse will last. If
    1.57 +     * keepAlive returns false, this should have no meaningful impact
    1.58 +     *
    1.59 +     * @param response
    1.60 +     *            The last response received over the connection.
    1.61 +     * @param context
    1.62 +     *            the context in which the connection is being used.
    1.63 +     *
    1.64 +     * @return the duration in ms for which it is safe to keep the connection
    1.65 +     *         idle, or <=0 if no suggested duration.
    1.66 +     */
    1.67 +    long getKeepAliveDuration(HttpResponse response, HttpContext context);
    1.68 +
    1.69 +}

mercurial