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 package org.apache.http.impl.conn.tsccm;
28
29 import java.util.concurrent.TimeUnit;
30
31 import org.apache.http.conn.ConnectionPoolTimeoutException;
32
33 /**
34 * Encapsulates a request for a {@link BasicPoolEntry}.
35 *
36 * @since 4.0
37 *
38 * @deprecated (4.2) use {@link java.util.concurrent.Future}
39 */
40 @Deprecated
41 public interface PoolEntryRequest {
42
43 /**
44 * Obtains a pool entry with a connection within the given timeout.
45 * If {@link #abortRequest()} is called before this completes
46 * an {@link InterruptedException} is thrown.
47 *
48 * @param timeout the timeout, 0 or negative for no timeout
49 * @param timeUnit the unit for the {@code timeout},
50 * may be {@code null} only if there is no timeout
51 *
52 * @return pool entry holding a connection for the route
53 *
54 * @throws ConnectionPoolTimeoutException
55 * if the timeout expired
56 * @throws InterruptedException
57 * if the calling thread was interrupted or the request was aborted
58 */
59 BasicPoolEntry getPoolEntry(
60 long timeout,
61 TimeUnit timeUnit) throws InterruptedException, ConnectionPoolTimeoutException;
62
63 /**
64 * Aborts the active or next call to
65 * {@link #getPoolEntry(long, TimeUnit)}.
66 */
67 void abortRequest();
68
69 }