mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ConnectionKeepAliveStrategy.java@6474c204b198 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ConnectionKeepAliveStrategy.java
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| 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 | package ch.boye.httpclientandroidlib.conn; |
| michael@0 | 28 | |
| michael@0 | 29 | import ch.boye.httpclientandroidlib.ConnectionReuseStrategy; |
| michael@0 | 30 | import ch.boye.httpclientandroidlib.HttpResponse; |
| michael@0 | 31 | import ch.boye.httpclientandroidlib.protocol.HttpContext; |
| michael@0 | 32 | |
| michael@0 | 33 | /** |
| michael@0 | 34 | * Interface for deciding how long a connection can remain |
| michael@0 | 35 | * idle before being reused. |
| michael@0 | 36 | * <p> |
| michael@0 | 37 | * Implementations of this interface must be thread-safe. Access to shared |
| michael@0 | 38 | * data must be synchronized as methods of this interface may be executed |
| michael@0 | 39 | * from multiple threads. |
| michael@0 | 40 | * |
| michael@0 | 41 | * @since 4.0 |
| michael@0 | 42 | */ |
| michael@0 | 43 | public interface ConnectionKeepAliveStrategy { |
| michael@0 | 44 | |
| michael@0 | 45 | /** |
| michael@0 | 46 | * Returns the duration of time which this connection can be safely kept |
| michael@0 | 47 | * idle. If the connection is left idle for longer than this period of time, |
| michael@0 | 48 | * it MUST not reused. A value of 0 or less may be returned to indicate that |
| michael@0 | 49 | * there is no suitable suggestion. |
| michael@0 | 50 | * |
| michael@0 | 51 | * When coupled with a {@link ConnectionReuseStrategy}, if |
| michael@0 | 52 | * {@link ConnectionReuseStrategy#keepAlive(HttpResponse, HttpContext)} |
| michael@0 | 53 | * returns true, this allows you to control how long the reuse will last. If |
| michael@0 | 54 | * keepAlive returns false, this should have no meaningful impact |
| michael@0 | 55 | * |
| michael@0 | 56 | * @param response |
| michael@0 | 57 | * The last response received over the connection. |
| michael@0 | 58 | * @param context |
| michael@0 | 59 | * the context in which the connection is being used. |
| michael@0 | 60 | * |
| michael@0 | 61 | * @return the duration in ms for which it is safe to keep the connection |
| michael@0 | 62 | * idle, or <=0 if no suggested duration. |
| michael@0 | 63 | */ |
| michael@0 | 64 | long getKeepAliveDuration(HttpResponse response, HttpContext context); |
| michael@0 | 65 | |
| michael@0 | 66 | } |
