mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ConnectionReleaseTrigger.java

changeset 0
6474c204b198
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ConnectionReleaseTrigger.java	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,70 @@
     1.4 +/*
     1.5 + * ====================================================================
     1.6 + *
     1.7 + *  Licensed to the Apache Software Foundation (ASF) under one or more
     1.8 + *  contributor license agreements.  See the NOTICE file distributed with
     1.9 + *  this work for additional information regarding copyright ownership.
    1.10 + *  The ASF licenses this file to You under the Apache License, Version 2.0
    1.11 + *  (the "License"); you may not use this file except in compliance with
    1.12 + *  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, software
    1.17 + *  distributed under the License is distributed on an "AS IS" BASIS,
    1.18 + *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    1.19 + *  See the License for the specific language governing permissions and
    1.20 + *  limitations under the License.
    1.21 + * ====================================================================
    1.22 + *
    1.23 + * This software consists of voluntary contributions made by many
    1.24 + * individuals on behalf of the Apache Software Foundation.  For more
    1.25 + * information on the Apache Software Foundation, please see
    1.26 + * <http://www.apache.org/>.
    1.27 + *
    1.28 + */
    1.29 +
    1.30 +package ch.boye.httpclientandroidlib.conn;
    1.31 +
    1.32 +import java.io.IOException;
    1.33 +
    1.34 +/**
    1.35 + * Interface for releasing a connection. This can be implemented by various
    1.36 + * "trigger" objects which are associated with a connection, for example
    1.37 + * a {@link EofSensorInputStream stream} or an {@link BasicManagedEntity entity}
    1.38 + * or the {@link ManagedClientConnection connection} itself.
    1.39 + * <p>
    1.40 + * The methods in this interface can safely be called multiple times.
    1.41 + * The first invocation releases the connection, subsequent calls
    1.42 + * are ignored.
    1.43 + *
    1.44 + * @since 4.0
    1.45 + */
    1.46 +public interface ConnectionReleaseTrigger {
    1.47 +
    1.48 +    /**
    1.49 +     * Releases the connection with the option of keep-alive. This is a
    1.50 +     * "graceful" release and may cause IO operations for consuming the
    1.51 +     * remainder of a response entity. Use
    1.52 +     * {@link #abortConnection abortConnection} for a hard release. The
    1.53 +     * connection may be reused as specified by the duration.
    1.54 +     *
    1.55 +     * @throws IOException
    1.56 +     *             in case of an IO problem. The connection will be released
    1.57 +     *             anyway.
    1.58 +     */
    1.59 +    void releaseConnection()
    1.60 +        throws IOException;
    1.61 +
    1.62 +    /**
    1.63 +     * Releases the connection without the option of keep-alive.
    1.64 +     * This is a "hard" release that implies a shutdown of the connection.
    1.65 +     * Use {@link #releaseConnection()} for a graceful release.
    1.66 +     *
    1.67 +     * @throws IOException      in case of an IO problem.
    1.68 +     *         The connection will be released anyway.
    1.69 +     */
    1.70 +    void abortConnection()
    1.71 +        throws IOException;
    1.72 +
    1.73 +}

mercurial