Thu, 22 Jan 2015 13:21:57 +0100
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
1 /*
2 * ====================================================================
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * 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, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ====================================================================
19 *
20 * This software consists of voluntary contributions made by many
21 * individuals on behalf of the Apache Software Foundation. For more
22 * information on the Apache Software Foundation, please see
23 * <http://www.apache.org/>.
24 *
25 */
27 package ch.boye.httpclientandroidlib.impl.conn.tsccm;
29 import java.util.concurrent.TimeUnit;
31 import ch.boye.httpclientandroidlib.conn.ConnectionPoolTimeoutException;
33 /**
34 * Encapsulates a request for a {@link BasicPoolEntry}.
35 *
36 * @since 4.0
37 */
38 public interface PoolEntryRequest {
40 /**
41 * Obtains a pool entry with a connection within the given timeout.
42 * If {@link #abortRequest()} is called before this completes
43 * an {@link InterruptedException} is thrown.
44 *
45 * @param timeout the timeout, 0 or negative for no timeout
46 * @param tunit the unit for the <code>timeout</code>,
47 * may be <code>null</code> only if there is no timeout
48 *
49 * @return pool entry holding a connection for the route
50 *
51 * @throws ConnectionPoolTimeoutException
52 * if the timeout expired
53 * @throws InterruptedException
54 * if the calling thread was interrupted or the request was aborted
55 */
56 BasicPoolEntry getPoolEntry(
57 long timeout,
58 TimeUnit tunit) throws InterruptedException, ConnectionPoolTimeoutException;
60 /**
61 * Aborts the active or next call to
62 * {@link #getPoolEntry(long, TimeUnit)}.
63 */
64 void abortRequest();
66 }