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/ClientConnectionManager.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 671717 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-06-25 21:03:24 -0700 (Wed, 25 Jun 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 Project 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.util.concurrent.TimeUnit; 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.conn.routing.HttpRoute; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.http.conn.scheme.SchemeRegistry; 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Management interface for {@link ManagedClientConnection client connections}. 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author Michael Becke 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a> 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a> 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:rolandw at apache.org">Roland Weber</a> 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <!-- empty lines to avoid svn diff problems --> 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 671717 $ 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 53d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 54d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 55d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 56d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 58d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface ClientConnectionManager { 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains the scheme registry used by this manager. 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return the scheme registry, never <code>null</code> 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project SchemeRegistry getSchemeRegistry() 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Returns a new {@link ClientConnectionRequest}, from which a 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link ManagedClientConnection} can be obtained or the request can be 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * aborted. 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ClientConnectionRequest requestConnection(HttpRoute route, Object state) 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Releases a connection for use by others. 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * You may optionally specify how long the connection is valid 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * to be reused. Values <= 0 are considered to be valid forever. 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If the connection is not marked as reusable, the connection will 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * not be reused regardless of the valid duration. 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If the connection has been released before, 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the call will be ignored. 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param conn the connection to release 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param validDuration the duration of time this connection is valid for reuse 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param timeUnit the unit of time validDuration is measured in 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #closeExpiredConnections() 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void releaseConnection(ManagedClientConnection conn, long validDuration, TimeUnit timeUnit) 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Closes idle connections in the pool. 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Open connections in the pool that have not been used for the 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * timespan given by the argument will be closed. 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Currently allocated connections are not subject to this method. 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Times will be checked with milliseconds precision 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * All expired connections will also be closed. 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param idletime the idle time of connections to be closed 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param tunit the unit for the <code>idletime</code> 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @see #closeExpiredConnections() 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void closeIdleConnections(long idletime, TimeUnit tunit) 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Closes all expired connections in the pool. 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Open connections in the pool that have not been used for 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the timespan defined when the connection was released will be closed. 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Currently allocated connections are not subject to this method. 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Times will be checked with milliseconds precision. 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void closeExpiredConnections(); 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Shuts down this connection manager and releases allocated resources. 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This includes closing all connections, whether they are currently 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * used or not. 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void shutdown() 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} // interface ClientConnectionManager 135