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 public interface ClientConnectionRequest { 40 41 /** 42 * Obtains a connection within a given time. 43 * This method will block until a connection becomes available, 44 * the timeout expires, or the connection manager is 45 * {@link ClientConnectionManager#shutdown() shut down}. 46 * Timeouts are handled with millisecond precision. 47 * 48 * If {@link #abortRequest()} is called while this is blocking or 49 * before this began, an {@link InterruptedException} will 50 * be thrown. 51 * 52 * @param timeout the timeout, 0 or negative for no timeout 53 * @param tunit the unit for the <code>timeout</code>, 54 * may be <code>null</code> only if there is no timeout 55 * 56 * @return a connection that can be used to communicate 57 * along the given route 58 * 59 * @throws ConnectionPoolTimeoutException 60 * in case of a timeout 61 * @throws InterruptedException 62 * if the calling thread is interrupted while waiting 63 */ 64 ManagedClientConnection getConnection(long timeout, TimeUnit tunit) 65 throws InterruptedException, ConnectionPoolTimeoutException; 66 67 /** 68 * Aborts the call to {@link #getConnection(long, TimeUnit)}, 69 * causing it to throw an {@link InterruptedException}. 70 */ 71 void abortRequest(); 72 73 } 74
