mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/conn/tsccm/PoolEntryRequest.java

Wed, 31 Dec 2014 07:22:50 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Wed, 31 Dec 2014 07:22:50 +0100
branch
TOR_BUG_3246
changeset 4
fc2d59ddac77
permissions
-rw-r--r--

Correct previous dual key logic pending first delivery installment.

michael@0 1 /*
michael@0 2 * ====================================================================
michael@0 3 *
michael@0 4 * Licensed to the Apache Software Foundation (ASF) under one or more
michael@0 5 * contributor license agreements. See the NOTICE file distributed with
michael@0 6 * this work for additional information regarding copyright ownership.
michael@0 7 * The ASF licenses this file to You under the Apache License, Version 2.0
michael@0 8 * (the "License"); you may not use this file except in compliance with
michael@0 9 * the License. You may obtain a copy of the License at
michael@0 10 *
michael@0 11 * http://www.apache.org/licenses/LICENSE-2.0
michael@0 12 *
michael@0 13 * Unless required by applicable law or agreed to in writing, software
michael@0 14 * distributed under the License is distributed on an "AS IS" BASIS,
michael@0 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0 16 * See the License for the specific language governing permissions and
michael@0 17 * limitations under the License.
michael@0 18 * ====================================================================
michael@0 19 *
michael@0 20 * This software consists of voluntary contributions made by many
michael@0 21 * individuals on behalf of the Apache Software Foundation. For more
michael@0 22 * information on the Apache Software Foundation, please see
michael@0 23 * <http://www.apache.org/>.
michael@0 24 *
michael@0 25 */
michael@0 26
michael@0 27 package ch.boye.httpclientandroidlib.impl.conn.tsccm;
michael@0 28
michael@0 29 import java.util.concurrent.TimeUnit;
michael@0 30
michael@0 31 import ch.boye.httpclientandroidlib.conn.ConnectionPoolTimeoutException;
michael@0 32
michael@0 33 /**
michael@0 34 * Encapsulates a request for a {@link BasicPoolEntry}.
michael@0 35 *
michael@0 36 * @since 4.0
michael@0 37 */
michael@0 38 public interface PoolEntryRequest {
michael@0 39
michael@0 40 /**
michael@0 41 * Obtains a pool entry with a connection within the given timeout.
michael@0 42 * If {@link #abortRequest()} is called before this completes
michael@0 43 * an {@link InterruptedException} is thrown.
michael@0 44 *
michael@0 45 * @param timeout the timeout, 0 or negative for no timeout
michael@0 46 * @param tunit the unit for the <code>timeout</code>,
michael@0 47 * may be <code>null</code> only if there is no timeout
michael@0 48 *
michael@0 49 * @return pool entry holding a connection for the route
michael@0 50 *
michael@0 51 * @throws ConnectionPoolTimeoutException
michael@0 52 * if the timeout expired
michael@0 53 * @throws InterruptedException
michael@0 54 * if the calling thread was interrupted or the request was aborted
michael@0 55 */
michael@0 56 BasicPoolEntry getPoolEntry(
michael@0 57 long timeout,
michael@0 58 TimeUnit tunit) throws InterruptedException, ConnectionPoolTimeoutException;
michael@0 59
michael@0 60 /**
michael@0 61 * Aborts the active or next call to
michael@0 62 * {@link #getPoolEntry(long, TimeUnit)}.
michael@0 63 */
michael@0 64 void abortRequest();
michael@0 65
michael@0 66 }

mercurial