michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.client.methods;
michael@0: 
michael@0: import java.io.IOException;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.client.HttpClient;
michael@0: import ch.boye.httpclientandroidlib.conn.ClientConnectionManager;
michael@0: import ch.boye.httpclientandroidlib.conn.ClientConnectionRequest;
michael@0: import ch.boye.httpclientandroidlib.conn.ConnectionReleaseTrigger;
michael@0: import ch.boye.httpclientandroidlib.conn.ManagedClientConnection;
michael@0: import ch.boye.httpclientandroidlib.impl.conn.tsccm.ThreadSafeClientConnManager;
michael@0: 
michael@0: /**
michael@0:  * Interface representing an HTTP request that can be aborted by shutting
michael@0:  * down the underlying HTTP connection.
michael@0:  *
michael@0:  *
michael@0:  * <!-- empty lines to avoid svn diff problems -->
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface AbortableHttpRequest {
michael@0: 
michael@0:     /**
michael@0:      * Sets the {@link ClientConnectionRequest} callback that can be
michael@0:      * used to abort a long-lived request for a connection.
michael@0:      * If the request is already aborted, throws an {@link IOException}.
michael@0:      *
michael@0:      * @see ClientConnectionManager
michael@0:      * @see ThreadSafeClientConnManager
michael@0:      */
michael@0:     void setConnectionRequest(ClientConnectionRequest connRequest) throws IOException;
michael@0: 
michael@0:     /**
michael@0:      * Sets the {@link ConnectionReleaseTrigger} callback that can
michael@0:      * be used to abort an active connection.
michael@0:      * Typically, this will be the {@link ManagedClientConnection} itself.
michael@0:      * If the request is already aborted, throws an {@link IOException}.
michael@0:      */
michael@0:     void setReleaseTrigger(ConnectionReleaseTrigger releaseTrigger) throws IOException;
michael@0: 
michael@0:     /**
michael@0:      * Aborts this http request. Any active execution of this method should
michael@0:      * return immediately. If the request has not started, it will abort after
michael@0:      * the next execution. Aborting this request will cause all subsequent
michael@0:      * executions with this request to fail.
michael@0:      *
michael@0:      * @see HttpClient#execute(HttpUriRequest)
michael@0:      * @see HttpClient#execute(ch.boye.httpclientandroidlib.HttpHost,
michael@0:      *      ch.boye.httpclientandroidlib.HttpRequest)
michael@0:      * @see HttpClient#execute(HttpUriRequest,
michael@0:      *      ch.boye.httpclientandroidlib.protocol.HttpContext)
michael@0:      * @see HttpClient#execute(ch.boye.httpclientandroidlib.HttpHost,
michael@0:      *      ch.boye.httpclientandroidlib.HttpRequest, ch.boye.httpclientandroidlib.protocol.HttpContext)
michael@0:      */
michael@0:     void abort();
michael@0: 
michael@0: }
michael@0: