1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/impl/conn/tsccm/PoolEntryRequest.java Wed Dec 31 06:09:35 2014 +0100 1.3 @@ -0,0 +1,66 @@ 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.impl.conn.tsccm; 1.31 + 1.32 +import java.util.concurrent.TimeUnit; 1.33 + 1.34 +import ch.boye.httpclientandroidlib.conn.ConnectionPoolTimeoutException; 1.35 + 1.36 +/** 1.37 + * Encapsulates a request for a {@link BasicPoolEntry}. 1.38 + * 1.39 + * @since 4.0 1.40 + */ 1.41 +public interface PoolEntryRequest { 1.42 + 1.43 + /** 1.44 + * Obtains a pool entry with a connection within the given timeout. 1.45 + * If {@link #abortRequest()} is called before this completes 1.46 + * an {@link InterruptedException} is thrown. 1.47 + * 1.48 + * @param timeout the timeout, 0 or negative for no timeout 1.49 + * @param tunit the unit for the <code>timeout</code>, 1.50 + * may be <code>null</code> only if there is no timeout 1.51 + * 1.52 + * @return pool entry holding a connection for the route 1.53 + * 1.54 + * @throws ConnectionPoolTimeoutException 1.55 + * if the timeout expired 1.56 + * @throws InterruptedException 1.57 + * if the calling thread was interrupted or the request was aborted 1.58 + */ 1.59 + BasicPoolEntry getPoolEntry( 1.60 + long timeout, 1.61 + TimeUnit tunit) throws InterruptedException, ConnectionPoolTimeoutException; 1.62 + 1.63 + /** 1.64 + * Aborts the active or next call to 1.65 + * {@link #getPoolEntry(long, TimeUnit)}. 1.66 + */ 1.67 + void abortRequest(); 1.68 + 1.69 +}