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