Home | History | Annotate | Download | only in conn
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/ClientConnectionRequest.java $
      3  * $Revision: 651815 $
      4  * $Date: 2008-04-26 04:14:43 -0700 (Sat, 26 Apr 2008) $
      5  *
      6  * ====================================================================
      7  * Licensed to the Apache Software Foundation (ASF) under one
      8  * or more contributor license agreements.  See the NOTICE file
      9  * distributed with this work for additional information
     10  * regarding copyright ownership.  The ASF licenses this file
     11  * to you under the Apache License, Version 2.0 (the
     12  * "License"); you may not use this file except in compliance
     13  * with the License.  You may obtain a copy of the License at
     14  *
     15  *   http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  * Unless required by applicable law or agreed to in writing,
     18  * software distributed under the License is distributed on an
     19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     20  * KIND, either express or implied.  See the License for the
     21  * specific language governing permissions and limitations
     22  * under the License.
     23  * ====================================================================
     24  *
     25  * This software consists of voluntary contributions made by many
     26  * individuals on behalf of the Apache Software Foundation.  For more
     27  * information on the Apache Software Foundation, please see
     28  * <http://www.apache.org/>.
     29  *
     30  */
     31 
     32 package org.apache.http.conn;
     33 
     34 import java.util.concurrent.TimeUnit;
     35 
     36 /**
     37  * Encapsulates a request for a {@link ManagedClientConnection}.
     38  *
     39  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     40  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     41  *     for further details.
     42  */
     43 @Deprecated
     44 public interface ClientConnectionRequest {
     45 
     46     /**
     47      * Obtains a connection within a given time.
     48      * This method will block until a connection becomes available,
     49      * the timeout expires, or the connection manager is
     50      * {@link ClientConnectionManager#shutdown() shut down}.
     51      * Timeouts are handled with millisecond precision.
     52      *
     53      * If {@link #abortRequest()} is called while this is blocking or
     54      * before this began, an {@link InterruptedException} will
     55      * be thrown.
     56      *
     57      * @param timeout   the timeout, 0 or negative for no timeout
     58      * @param tunit     the unit for the <code>timeout</code>,
     59      *                  may be <code>null</code> only if there is no timeout
     60      *
     61      * @return  a connection that can be used to communicate
     62      *          along the given route
     63      *
     64      * @throws ConnectionPoolTimeoutException
     65      *         in case of a timeout
     66      * @throws InterruptedException
     67      *         if the calling thread is interrupted while waiting
     68      */
     69     ManagedClientConnection getConnection(long timeout, TimeUnit tunit)
     70         throws InterruptedException, ConnectionPoolTimeoutException;
     71 
     72     /**
     73      * Aborts the call to {@link #getConnection(long, TimeUnit)},
     74      * causing it to throw an {@link InterruptedException}.
     75      */
     76     void abortRequest();
     77 
     78 }
     79