mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/methods/AbortableHttpRequest.java@6474c204b198 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/methods/AbortableHttpRequest.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 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib.client.methods; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.io.IOException; |
| michael@0 | 31 | |
| michael@0 | 32 | import ch.boye.httpclientandroidlib.client.HttpClient; |
| michael@0 | 33 | import ch.boye.httpclientandroidlib.conn.ClientConnectionManager; |
| michael@0 | 34 | import ch.boye.httpclientandroidlib.conn.ClientConnectionRequest; |
| michael@0 | 35 | import ch.boye.httpclientandroidlib.conn.ConnectionReleaseTrigger; |
| michael@0 | 36 | import ch.boye.httpclientandroidlib.conn.ManagedClientConnection; |
| michael@0 | 37 | import ch.boye.httpclientandroidlib.impl.conn.tsccm.ThreadSafeClientConnManager; |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * Interface representing an HTTP request that can be aborted by shutting |
| michael@0 | 41 | * down the underlying HTTP connection. |
| michael@0 | 42 | * |
| michael@0 | 43 | * |
| michael@0 | 44 | * <!-- empty lines to avoid svn diff problems --> |
| michael@0 | 45 | * @since 4.0 |
| michael@0 | 46 | */ |
| michael@0 | 47 | public interface AbortableHttpRequest { |
| michael@0 | 48 | |
| michael@0 | 49 | /** |
| michael@0 | 50 | * Sets the {@link ClientConnectionRequest} callback that can be |
| michael@0 | 51 | * used to abort a long-lived request for a connection. |
| michael@0 | 52 | * If the request is already aborted, throws an {@link IOException}. |
| michael@0 | 53 | * |
| michael@0 | 54 | * @see ClientConnectionManager |
| michael@0 | 55 | * @see ThreadSafeClientConnManager |
| michael@0 | 56 | */ |
| michael@0 | 57 | void setConnectionRequest(ClientConnectionRequest connRequest) throws IOException; |
| michael@0 | 58 | |
| michael@0 | 59 | /** |
| michael@0 | 60 | * Sets the {@link ConnectionReleaseTrigger} callback that can |
| michael@0 | 61 | * be used to abort an active connection. |
| michael@0 | 62 | * Typically, this will be the {@link ManagedClientConnection} itself. |
| michael@0 | 63 | * If the request is already aborted, throws an {@link IOException}. |
| michael@0 | 64 | */ |
| michael@0 | 65 | void setReleaseTrigger(ConnectionReleaseTrigger releaseTrigger) throws IOException; |
| michael@0 | 66 | |
| michael@0 | 67 | /** |
| michael@0 | 68 | * Aborts this http request. Any active execution of this method should |
| michael@0 | 69 | * return immediately. If the request has not started, it will abort after |
| michael@0 | 70 | * the next execution. Aborting this request will cause all subsequent |
| michael@0 | 71 | * executions with this request to fail. |
| michael@0 | 72 | * |
| michael@0 | 73 | * @see HttpClient#execute(HttpUriRequest) |
| michael@0 | 74 | * @see HttpClient#execute(ch.boye.httpclientandroidlib.HttpHost, |
| michael@0 | 75 | * ch.boye.httpclientandroidlib.HttpRequest) |
| michael@0 | 76 | * @see HttpClient#execute(HttpUriRequest, |
| michael@0 | 77 | * ch.boye.httpclientandroidlib.protocol.HttpContext) |
| michael@0 | 78 | * @see HttpClient#execute(ch.boye.httpclientandroidlib.HttpHost, |
| michael@0 | 79 | * ch.boye.httpclientandroidlib.HttpRequest, ch.boye.httpclientandroidlib.protocol.HttpContext) |
| michael@0 | 80 | */ |
| michael@0 | 81 | void abort(); |
| michael@0 | 82 | |
| michael@0 | 83 | } |
| michael@0 | 84 |
