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/ConnectionReleaseTrigger.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 672367 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-06-27 12:49:20 -0700 (Fri, 27 Jun 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * this work for additional information regarding copyright ownership. 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * (the "License"); you may not use this file except in compliance with 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 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, software 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * See the License for the specific language governing permissions and 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * limitations under the License. 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.conn; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.io.IOException; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Interface for releasing a connection. 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This can be implemented by various "trigger" objects which are 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * associated with a connection, for example 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * a {@link EofSensorInputStream stream} 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or an {@link BasicManagedEntity entity} 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * or the {@link ManagedClientConnection connection} itself. 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <br/> 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The methods in this interface can safely be called multiple times. 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The first invocation releases the connection, subsequent calls 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * are ignored. 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @author <a href="mailto:rolandw at apache.org">Roland Weber</a> 49069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 50069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 51069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <!-- empty lines to avoid svn diff problems --> 52069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @version $Revision: 672367 $ 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 54069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @since 4.0 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic interface ConnectionReleaseTrigger { 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Releases the connection with the option of keep-alive. This is a 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * "graceful" release and may cause IO operations for consuming the 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * remainder of a response entity. Use 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link #abortConnection abortConnection} for a hard release. The 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * connection may be reused as specified by the duration. 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IOException 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * in case of an IO problem. The connection will be released 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * anyway. 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void releaseConnection() 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Releases the connection without the option of keep-alive. 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This is a "hard" release that implies a shutdown of the connection. 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Use {@link #releaseConnection releaseConnection} for a graceful release. 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @throws IOException in case of an IO problem. 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The connection will be released anyway. 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project void abortConnection() 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throws IOException 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project ; 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} // interface ConnectionReleaseTrigger 87