1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/client/methods/AbortableHttpRequest.java Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,84 @@
1.4 +/*
1.5 + * ====================================================================
1.6 + * Licensed to the Apache Software Foundation (ASF) under one
1.7 + * or more contributor license agreements. See the NOTICE file
1.8 + * distributed with this work for additional information
1.9 + * regarding copyright ownership. The ASF licenses this file
1.10 + * to you under the Apache License, Version 2.0 (the
1.11 + * "License"); you may not use this file except in compliance
1.12 + * with the License. You may obtain a copy of the License at
1.13 + *
1.14 + * http://www.apache.org/licenses/LICENSE-2.0
1.15 + *
1.16 + * Unless required by applicable law or agreed to in writing,
1.17 + * software distributed under the License is distributed on an
1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
1.19 + * KIND, either express or implied. See the License for the
1.20 + * specific language governing permissions and limitations
1.21 + * under the License.
1.22 + * ====================================================================
1.23 + *
1.24 + * This software consists of voluntary contributions made by many
1.25 + * individuals on behalf of the Apache Software Foundation. For more
1.26 + * information on the Apache Software Foundation, please see
1.27 + * <http://www.apache.org/>.
1.28 + *
1.29 + */
1.30 +
1.31 +package ch.boye.httpclientandroidlib.client.methods;
1.32 +
1.33 +import java.io.IOException;
1.34 +
1.35 +import ch.boye.httpclientandroidlib.client.HttpClient;
1.36 +import ch.boye.httpclientandroidlib.conn.ClientConnectionManager;
1.37 +import ch.boye.httpclientandroidlib.conn.ClientConnectionRequest;
1.38 +import ch.boye.httpclientandroidlib.conn.ConnectionReleaseTrigger;
1.39 +import ch.boye.httpclientandroidlib.conn.ManagedClientConnection;
1.40 +import ch.boye.httpclientandroidlib.impl.conn.tsccm.ThreadSafeClientConnManager;
1.41 +
1.42 +/**
1.43 + * Interface representing an HTTP request that can be aborted by shutting
1.44 + * down the underlying HTTP connection.
1.45 + *
1.46 + *
1.47 + * <!-- empty lines to avoid svn diff problems -->
1.48 + * @since 4.0
1.49 + */
1.50 +public interface AbortableHttpRequest {
1.51 +
1.52 + /**
1.53 + * Sets the {@link ClientConnectionRequest} callback that can be
1.54 + * used to abort a long-lived request for a connection.
1.55 + * If the request is already aborted, throws an {@link IOException}.
1.56 + *
1.57 + * @see ClientConnectionManager
1.58 + * @see ThreadSafeClientConnManager
1.59 + */
1.60 + void setConnectionRequest(ClientConnectionRequest connRequest) throws IOException;
1.61 +
1.62 + /**
1.63 + * Sets the {@link ConnectionReleaseTrigger} callback that can
1.64 + * be used to abort an active connection.
1.65 + * Typically, this will be the {@link ManagedClientConnection} itself.
1.66 + * If the request is already aborted, throws an {@link IOException}.
1.67 + */
1.68 + void setReleaseTrigger(ConnectionReleaseTrigger releaseTrigger) throws IOException;
1.69 +
1.70 + /**
1.71 + * Aborts this http request. Any active execution of this method should
1.72 + * return immediately. If the request has not started, it will abort after
1.73 + * the next execution. Aborting this request will cause all subsequent
1.74 + * executions with this request to fail.
1.75 + *
1.76 + * @see HttpClient#execute(HttpUriRequest)
1.77 + * @see HttpClient#execute(ch.boye.httpclientandroidlib.HttpHost,
1.78 + * ch.boye.httpclientandroidlib.HttpRequest)
1.79 + * @see HttpClient#execute(HttpUriRequest,
1.80 + * ch.boye.httpclientandroidlib.protocol.HttpContext)
1.81 + * @see HttpClient#execute(ch.boye.httpclientandroidlib.HttpHost,
1.82 + * ch.boye.httpclientandroidlib.HttpRequest, ch.boye.httpclientandroidlib.protocol.HttpContext)
1.83 + */
1.84 + void abort();
1.85 +
1.86 +}
1.87 +
