001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.conn;
029
030import java.util.concurrent.TimeUnit;
031
032/**
033 * Encapsulates a request for a {@link ManagedClientConnection}.
034 *
035 * @since 4.0
036 *
037 * @deprecated (4.3) replaced by {@link ConnectionRequest}.
038 */
039@Deprecated
040public interface ClientConnectionRequest {
041
042    /**
043     * Obtains a connection within a given time.
044     * This method will block until a connection becomes available,
045     * the timeout expires, or the connection manager is
046     * {@link ClientConnectionManager#shutdown() shut down}.
047     * Timeouts are handled with millisecond precision.
048     *
049     * If {@link #abortRequest()} is called while this is blocking or
050     * before this began, an {@link InterruptedException} will
051     * be thrown.
052     *
053     * @param timeout   the timeout, 0 or negative for no timeout
054     * @param tunit     the unit for the {@code timeout},
055     *                  may be {@code null} only if there is no timeout
056     *
057     * @return  a connection that can be used to communicate
058     *          along the given route
059     *
060     * @throws ConnectionPoolTimeoutException
061     *         in case of a timeout
062     * @throws InterruptedException
063     *         if the calling thread is interrupted while waiting
064     */
065    ManagedClientConnection getConnection(long timeout, TimeUnit tunit)
066        throws InterruptedException, ConnectionPoolTimeoutException;
067
068    /**
069     * Aborts the call to {@link #getConnection(long, TimeUnit)},
070     * causing it to throw an {@link InterruptedException}.
071     */
072    void abortRequest();
073
074}