mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ClientConnectionRequest.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/ClientConnectionRequest.java	Wed Dec 31 06:09:35 2014 +0100
     1.3 @@ -0,0 +1,71 @@
     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.conn;
    1.32 +
    1.33 +import java.util.concurrent.TimeUnit;
    1.34 +
    1.35 +/**
    1.36 + * Encapsulates a request for a {@link ManagedClientConnection}.
    1.37 + *
    1.38 + * @since 4.0
    1.39 + */
    1.40 +public interface ClientConnectionRequest {
    1.41 +
    1.42 +    /**
    1.43 +     * Obtains a connection within a given time.
    1.44 +     * This method will block until a connection becomes available,
    1.45 +     * the timeout expires, or the connection manager is
    1.46 +     * {@link ClientConnectionManager#shutdown() shut down}.
    1.47 +     * Timeouts are handled with millisecond precision.
    1.48 +     *
    1.49 +     * If {@link #abortRequest()} is called while this is blocking or
    1.50 +     * before this began, an {@link InterruptedException} will
    1.51 +     * be thrown.
    1.52 +     *
    1.53 +     * @param timeout   the timeout, 0 or negative for no timeout
    1.54 +     * @param tunit     the unit for the <code>timeout</code>,
    1.55 +     *                  may be <code>null</code> only if there is no timeout
    1.56 +     *
    1.57 +     * @return  a connection that can be used to communicate
    1.58 +     *          along the given route
    1.59 +     *
    1.60 +     * @throws ConnectionPoolTimeoutException
    1.61 +     *         in case of a timeout
    1.62 +     * @throws InterruptedException
    1.63 +     *         if the calling thread is interrupted while waiting
    1.64 +     */
    1.65 +    ManagedClientConnection getConnection(long timeout, TimeUnit tunit)
    1.66 +        throws InterruptedException, ConnectionPoolTimeoutException;
    1.67 +
    1.68 +    /**
    1.69 +     * Aborts the call to {@link #getConnection(long, TimeUnit)},
    1.70 +     * causing it to throw an {@link InterruptedException}.
    1.71 +     */
    1.72 +    void abortRequest();
    1.73 +
    1.74 +}

mercurial