mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ConnectionReleaseTrigger.java@6474c204b198 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ConnectionReleaseTrigger.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 | * |
| michael@0 | 4 | * Licensed to the Apache Software Foundation (ASF) under one or more |
| michael@0 | 5 | * contributor license agreements. See the NOTICE file distributed with |
| michael@0 | 6 | * this work for additional information regarding copyright ownership. |
| michael@0 | 7 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
| michael@0 | 8 | * (the "License"); you may not use this file except in compliance with |
| michael@0 | 9 | * 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, software |
| michael@0 | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
| michael@0 | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| michael@0 | 16 | * See the License for the specific language governing permissions and |
| michael@0 | 17 | * limitations under the License. |
| michael@0 | 18 | * ==================================================================== |
| michael@0 | 19 | * |
| michael@0 | 20 | * This software consists of voluntary contributions made by many |
| michael@0 | 21 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 22 | * information on the Apache Software Foundation, please see |
| michael@0 | 23 | * <http://www.apache.org/>. |
| michael@0 | 24 | * |
| michael@0 | 25 | */ |
| michael@0 | 26 | |
| michael@0 | 27 | package ch.boye.httpclientandroidlib.conn; |
| michael@0 | 28 | |
| michael@0 | 29 | import java.io.IOException; |
| michael@0 | 30 | |
| michael@0 | 31 | /** |
| michael@0 | 32 | * Interface for releasing a connection. This can be implemented by various |
| michael@0 | 33 | * "trigger" objects which are associated with a connection, for example |
| michael@0 | 34 | * a {@link EofSensorInputStream stream} or an {@link BasicManagedEntity entity} |
| michael@0 | 35 | * or the {@link ManagedClientConnection connection} itself. |
| michael@0 | 36 | * <p> |
| michael@0 | 37 | * The methods in this interface can safely be called multiple times. |
| michael@0 | 38 | * The first invocation releases the connection, subsequent calls |
| michael@0 | 39 | * are ignored. |
| michael@0 | 40 | * |
| michael@0 | 41 | * @since 4.0 |
| michael@0 | 42 | */ |
| michael@0 | 43 | public interface ConnectionReleaseTrigger { |
| michael@0 | 44 | |
| michael@0 | 45 | /** |
| michael@0 | 46 | * Releases the connection with the option of keep-alive. This is a |
| michael@0 | 47 | * "graceful" release and may cause IO operations for consuming the |
| michael@0 | 48 | * remainder of a response entity. Use |
| michael@0 | 49 | * {@link #abortConnection abortConnection} for a hard release. The |
| michael@0 | 50 | * connection may be reused as specified by the duration. |
| michael@0 | 51 | * |
| michael@0 | 52 | * @throws IOException |
| michael@0 | 53 | * in case of an IO problem. The connection will be released |
| michael@0 | 54 | * anyway. |
| michael@0 | 55 | */ |
| michael@0 | 56 | void releaseConnection() |
| michael@0 | 57 | throws IOException; |
| michael@0 | 58 | |
| michael@0 | 59 | /** |
| michael@0 | 60 | * Releases the connection without the option of keep-alive. |
| michael@0 | 61 | * This is a "hard" release that implies a shutdown of the connection. |
| michael@0 | 62 | * Use {@link #releaseConnection()} for a graceful release. |
| michael@0 | 63 | * |
| michael@0 | 64 | * @throws IOException in case of an IO problem. |
| michael@0 | 65 | * The connection will be released anyway. |
| michael@0 | 66 | */ |
| michael@0 | 67 | void abortConnection() |
| michael@0 | 68 | throws IOException; |
| michael@0 | 69 | |
| michael@0 | 70 | } |
