michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with 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,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * 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.conn;
michael@0: 
michael@0: import java.util.concurrent.TimeUnit;
michael@0: 
michael@0: /**
michael@0:  * Encapsulates a request for a {@link ManagedClientConnection}.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface ClientConnectionRequest {
michael@0: 
michael@0:     /**
michael@0:      * Obtains a connection within a given time.
michael@0:      * This method will block until a connection becomes available,
michael@0:      * the timeout expires, or the connection manager is
michael@0:      * {@link ClientConnectionManager#shutdown() shut down}.
michael@0:      * Timeouts are handled with millisecond precision.
michael@0:      *
michael@0:      * If {@link #abortRequest()} is called while this is blocking or
michael@0:      * before this began, an {@link InterruptedException} will
michael@0:      * be 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  a connection that can be used to communicate
michael@0:      *          along the given route
michael@0:      *
michael@0:      * @throws ConnectionPoolTimeoutException
michael@0:      *         in case of a timeout
michael@0:      * @throws InterruptedException
michael@0:      *         if the calling thread is interrupted while waiting
michael@0:      */
michael@0:     ManagedClientConnection getConnection(long timeout, TimeUnit tunit)
michael@0:         throws InterruptedException, ConnectionPoolTimeoutException;
michael@0: 
michael@0:     /**
michael@0:      * Aborts the call to {@link #getConnection(long, TimeUnit)},
michael@0:      * causing it to throw an {@link InterruptedException}.
michael@0:      */
michael@0:     void abortRequest();
michael@0: 
michael@0: }