1 /*
2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/PoolEntryRequest.java $
3  * $Revision: 652020 $
4  * $Date: 2008-04-27 14:23:31 -0700 (Sun, 27 Apr 2008) $
5  *
6  * ====================================================================
7  *
8  *  Licensed to the Apache Software Foundation (ASF) under one or more
9  *  contributor license agreements.  See the NOTICE file distributed with
10  *  this work for additional information regarding copyright ownership.
11  *  The ASF licenses this file to You under the Apache License, Version 2.0
12  *  (the "License"); you may not use this file except in compliance with
13  *  the License.  You may obtain a copy of the License at
14  *
15  *      http://www.apache.org/licenses/LICENSE-2.0
16  *
17  *  Unless required by applicable law or agreed to in writing, software
18  *  distributed under the License is distributed on an "AS IS" BASIS,
19  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20  *  See the License for the specific language governing permissions and
21  *  limitations under the License.
22  * ====================================================================
23  *
24  * This software consists of voluntary contributions made by many
25  * individuals on behalf of the Apache Software Foundation.  For more
26  * information on the Apache Software Foundation, please see
27  * <http://www.apache.org/>.
28  *
29  */
30 
31 package org.apache.http.impl.conn.tsccm;
32 
33 import java.util.concurrent.TimeUnit;
34 
35 import org.apache.http.conn.ConnectionPoolTimeoutException;
36 
37 /**
38  * Encapsulates a request for a {@link BasicPoolEntry}.
39  *
40  * @deprecated Please use {@link java.net.URL#openConnection} instead.
41  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
42  *     for further details.
43  */
44 @Deprecated
45 public interface PoolEntryRequest {
46 
47     /**
48      * Obtains a pool entry with a connection within the given timeout.
49      * If {@link #abortRequest()} is called before this completes
50      * an {@link InterruptedException} is thrown.
51      *
52      * @param timeout   the timeout, 0 or negative for no timeout
53      * @param tunit     the unit for the <code>timeout</code>,
54      *                  may be <code>null</code> only if there is no timeout
55      *
56      * @return  pool entry holding a connection for the route
57      *
58      * @throws ConnectionPoolTimeoutException
59      *         if the timeout expired
60      * @throws InterruptedException
61      *         if the calling thread was interrupted or the request was aborted
62      */
getPoolEntry( long timeout, TimeUnit tunit)63     BasicPoolEntry getPoolEntry(
64             long timeout,
65             TimeUnit tunit) throws InterruptedException, ConnectionPoolTimeoutException;
66 
67     /**
68      * Aborts the active or next call to
69      * {@link #getPoolEntry(long, TimeUnit)}.
70      */
abortRequest()71     void abortRequest();
72 
73 }
74