michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *      http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  *  Unless required by applicable law or agreed to in writing, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.impl.conn.tsccm;
michael@0: 
michael@0: import java.util.concurrent.TimeUnit;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.conn.ConnectionPoolTimeoutException;
michael@0: 
michael@0: /**
michael@0:  * Encapsulates a request for a {@link BasicPoolEntry}.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface PoolEntryRequest {
michael@0: 
michael@0:     /**
michael@0:      * Obtains a pool entry with a connection within the given timeout.
michael@0:      * If {@link #abortRequest()} is called before this completes
michael@0:      * an {@link InterruptedException} is thrown.
michael@0:      *
michael@0:      * @param timeout   the timeout, 0 or negative for no timeout
michael@0:      * @param tunit     the unit for the <code>timeout</code>,
michael@0:      *                  may be <code>null</code> only if there is no timeout
michael@0:      *
michael@0:      * @return  pool entry holding a connection for the route
michael@0:      *
michael@0:      * @throws ConnectionPoolTimeoutException
michael@0:      *         if the timeout expired
michael@0:      * @throws InterruptedException
michael@0:      *         if the calling thread was interrupted or the request was aborted
michael@0:      */
michael@0:     BasicPoolEntry getPoolEntry(
michael@0:             long timeout,
michael@0:             TimeUnit tunit) throws InterruptedException, ConnectionPoolTimeoutException;
michael@0: 
michael@0:     /**
michael@0:      * Aborts the active or next call to
michael@0:      * {@link #getPoolEntry(long, TimeUnit)}.
michael@0:      */
michael@0:     void abortRequest();
michael@0: 
michael@0: }