mobile/android/thirdparty/ch/boye/httpclientandroidlib/ConnectionReuseStrategy.java

Wed, 31 Dec 2014 07:22:50 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 07:22:50 +0100
branch
TOR_BUG_3246
changeset 4
fc2d59ddac77
permissions
-rw-r--r--

Correct previous dual key logic pending first delivery installment.

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 * Licensed to the Apache Software Foundation (ASF) under one
michael@0 4 * or more contributor license agreements. See the NOTICE file
michael@0 5 * distributed with this work for additional information
michael@0 6 * regarding copyright ownership. The ASF licenses this file
michael@0 7 * to you under the Apache License, Version 2.0 (the
michael@0 8 * "License"); you may not use this file except in compliance
michael@0 9 * with the License. You may obtain a copy of the License at
michael@0 10 *
michael@0 11 * http://www.apache.org/licenses/LICENSE-2.0
michael@0 12 *
michael@0 13 * Unless required by applicable law or agreed to in writing,
michael@0 14 * software distributed under the License is distributed on an
michael@0 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0 16 * KIND, either express or implied. See the License for the
michael@0 17 * specific language governing permissions and limitations
michael@0 18 * under the License.
michael@0 19 * ====================================================================
michael@0 20 *
michael@0 21 * This software consists of voluntary contributions made by many
michael@0 22 * individuals on behalf of the Apache Software Foundation. For more
michael@0 23 * information on the Apache Software Foundation, please see
michael@0 24 * <http://www.apache.org/>.
michael@0 25 *
michael@0 26 */
michael@0 27
michael@0 28 package ch.boye.httpclientandroidlib;
michael@0 29
michael@0 30 import ch.boye.httpclientandroidlib.protocol.HttpContext;
michael@0 31
michael@0 32 /**
michael@0 33 * Interface for deciding whether a connection can be re-used for
michael@0 34 * subsequent requests and should be kept alive.
michael@0 35 * <p>
michael@0 36 * Implementations of this interface must be thread-safe. Access to shared
michael@0 37 * data must be synchronized as methods of this interface may be executed
michael@0 38 * from multiple threads.
michael@0 39 *
michael@0 40 * @since 4.0
michael@0 41 */
michael@0 42 public interface ConnectionReuseStrategy {
michael@0 43
michael@0 44 /**
michael@0 45 * Decides whether a connection can be kept open after a request.
michael@0 46 * If this method returns <code>false</code>, the caller MUST
michael@0 47 * close the connection to correctly comply with the HTTP protocol.
michael@0 48 * If it returns <code>true</code>, the caller SHOULD attempt to
michael@0 49 * keep the connection open for reuse with another request.
michael@0 50 * <br/>
michael@0 51 * One can use the HTTP context to retrieve additional objects that
michael@0 52 * may be relevant for the keep-alive strategy: the actual HTTP
michael@0 53 * connection, the original HTTP request, target host if known,
michael@0 54 * number of times the connection has been reused already and so on.
michael@0 55 * <br/>
michael@0 56 * If the connection is already closed, <code>false</code> is returned.
michael@0 57 * The stale connection check MUST NOT be triggered by a
michael@0 58 * connection reuse strategy.
michael@0 59 *
michael@0 60 * @param response
michael@0 61 * The last response received over that connection.
michael@0 62 * @param context the context in which the connection is being
michael@0 63 * used.
michael@0 64 *
michael@0 65 * @return <code>true</code> if the connection is allowed to be reused, or
michael@0 66 * <code>false</code> if it MUST NOT be reused
michael@0 67 */
michael@0 68 boolean keepAlive(HttpResponse response, HttpContext context);
michael@0 69
michael@0 70 }

mercurial