|
1 /* |
|
2 * ==================================================================== |
|
3 * Licensed to the Apache Software Foundation (ASF) under one |
|
4 * or more contributor license agreements. See the NOTICE file |
|
5 * distributed with this work for additional information |
|
6 * regarding copyright ownership. The ASF licenses this file |
|
7 * to you under the Apache License, Version 2.0 (the |
|
8 * "License"); you may not use this file except in compliance |
|
9 * with the License. You may obtain a copy of the License at |
|
10 * |
|
11 * http://www.apache.org/licenses/LICENSE-2.0 |
|
12 * |
|
13 * Unless required by applicable law or agreed to in writing, |
|
14 * software distributed under the License is distributed on an |
|
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
|
16 * KIND, either express or implied. See the License for the |
|
17 * specific language governing permissions and limitations |
|
18 * under the License. |
|
19 * ==================================================================== |
|
20 * |
|
21 * This software consists of voluntary contributions made by many |
|
22 * individuals on behalf of the Apache Software Foundation. For more |
|
23 * information on the Apache Software Foundation, please see |
|
24 * <http://www.apache.org/>. |
|
25 * |
|
26 */ |
|
27 |
|
28 package ch.boye.httpclientandroidlib.conn; |
|
29 |
|
30 import java.util.concurrent.TimeUnit; |
|
31 |
|
32 /** |
|
33 * Encapsulates a request for a {@link ManagedClientConnection}. |
|
34 * |
|
35 * @since 4.0 |
|
36 */ |
|
37 public interface ClientConnectionRequest { |
|
38 |
|
39 /** |
|
40 * Obtains a connection within a given time. |
|
41 * This method will block until a connection becomes available, |
|
42 * the timeout expires, or the connection manager is |
|
43 * {@link ClientConnectionManager#shutdown() shut down}. |
|
44 * Timeouts are handled with millisecond precision. |
|
45 * |
|
46 * If {@link #abortRequest()} is called while this is blocking or |
|
47 * before this began, an {@link InterruptedException} will |
|
48 * be thrown. |
|
49 * |
|
50 * @param timeout the timeout, 0 or negative for no timeout |
|
51 * @param tunit the unit for the <code>timeout</code>, |
|
52 * may be <code>null</code> only if there is no timeout |
|
53 * |
|
54 * @return a connection that can be used to communicate |
|
55 * along the given route |
|
56 * |
|
57 * @throws ConnectionPoolTimeoutException |
|
58 * in case of a timeout |
|
59 * @throws InterruptedException |
|
60 * if the calling thread is interrupted while waiting |
|
61 */ |
|
62 ManagedClientConnection getConnection(long timeout, TimeUnit tunit) |
|
63 throws InterruptedException, ConnectionPoolTimeoutException; |
|
64 |
|
65 /** |
|
66 * Aborts the call to {@link #getConnection(long, TimeUnit)}, |
|
67 * causing it to throw an {@link InterruptedException}. |
|
68 */ |
|
69 void abortRequest(); |
|
70 |
|
71 } |