1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/ClientConnectionRequest.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 651815 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-04-26 04:14:43 -0700 (Sat, 26 Apr 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or more contributor license agreements. See the NOTICE file 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed with this work for additional information 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * regarding copyright ownership. The ASF licenses this file 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to you under the Apache License, Version 2.0 (the 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "License"); you may not use this file except in compliance 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * with the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * software distributed under the License is distributed on an 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * KIND, either express or implied. See the License for the 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * specific language governing permissions and limitations 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * under the License. 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.conn; 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.concurrent.TimeUnit; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Encapsulates a request for a {@link ManagedClientConnection}. 38d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 39d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 40d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 41d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 43d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface ClientConnectionRequest { 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains a connection within a given time. 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This method will block until a connection becomes available, 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the timeout expires, or the connection manager is 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link ClientConnectionManager#shutdown() shut down}. 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Timeouts are handled with millisecond precision. 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If {@link #abortRequest()} is called while this is blocking or 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * before this began, an {@link InterruptedException} will 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * be thrown. 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param timeout the timeout, 0 or negative for no timeout 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param tunit the unit for the <code>timeout</code>, 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * may be <code>null</code> only if there is no timeout 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a connection that can be used to communicate 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * along the given route 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws ConnectionPoolTimeoutException 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in case of a timeout 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws InterruptedException 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * if the calling thread is interrupted while waiting 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ManagedClientConnection getConnection(long timeout, TimeUnit tunit) 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws InterruptedException, ConnectionPoolTimeoutException; 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Aborts the call to {@link #getConnection(long, TimeUnit)}, 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * causing it to throw an {@link InterruptedException}. 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void abortRequest(); 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} 79