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