mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ClientConnectionRequest.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ClientConnectionRequest.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.conn; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.util.concurrent.TimeUnit; |
| michael@0 | 31 | |
| michael@0 | 32 | /** |
| michael@0 | 33 | * Encapsulates a request for a {@link ManagedClientConnection}. |
| michael@0 | 34 | * |
| michael@0 | 35 | * @since 4.0 |
| michael@0 | 36 | */ |
| michael@0 | 37 | public interface ClientConnectionRequest { |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * Obtains a connection within a given time. |
| michael@0 | 41 | * This method will block until a connection becomes available, |
| michael@0 | 42 | * the timeout expires, or the connection manager is |
| michael@0 | 43 | * {@link ClientConnectionManager#shutdown() shut down}. |
| michael@0 | 44 | * Timeouts are handled with millisecond precision. |
| michael@0 | 45 | * |
| michael@0 | 46 | * If {@link #abortRequest()} is called while this is blocking or |
| michael@0 | 47 | * before this began, an {@link InterruptedException} will |
| michael@0 | 48 | * be thrown. |
| michael@0 | 49 | * |
| michael@0 | 50 | * @param timeout the timeout, 0 or negative for no timeout |
| michael@0 | 51 | * @param tunit the unit for the <code>timeout</code>, |
| michael@0 | 52 | * may be <code>null</code> only if there is no timeout |
| michael@0 | 53 | * |
| michael@0 | 54 | * @return a connection that can be used to communicate |
| michael@0 | 55 | * along the given route |
| michael@0 | 56 | * |
| michael@0 | 57 | * @throws ConnectionPoolTimeoutException |
| michael@0 | 58 | * in case of a timeout |
| michael@0 | 59 | * @throws InterruptedException |
| michael@0 | 60 | * if the calling thread is interrupted while waiting |
| michael@0 | 61 | */ |
| michael@0 | 62 | ManagedClientConnection getConnection(long timeout, TimeUnit tunit) |
| michael@0 | 63 | throws InterruptedException, ConnectionPoolTimeoutException; |
| michael@0 | 64 | |
| michael@0 | 65 | /** |
| michael@0 | 66 | * Aborts the call to {@link #getConnection(long, TimeUnit)}, |
| michael@0 | 67 | * causing it to throw an {@link InterruptedException}. |
| michael@0 | 68 | */ |
| michael@0 | 69 | void abortRequest(); |
| michael@0 | 70 | |
| michael@0 | 71 | } |
