Interface LeaseRequest

  • All Superinterfaces:
    org.apache.hc.core5.concurrent.Cancellable

    public interface LeaseRequest
    extends org.apache.hc.core5.concurrent.Cancellable
    Represents a request for a ConnectionEndpoint whose life cycle is managed by a connection manager.
    Since:
    5.0
    • Method Detail

      • get

        ConnectionEndpoint get​(org.apache.hc.core5.util.Timeout timeout)
                        throws java.lang.InterruptedException,
                               java.util.concurrent.ExecutionException,
                               java.util.concurrent.TimeoutException
        Returns ConnectionEndpoint within a given time. This method will block until a connection becomes available, the timeout expires, or the connection manager is shut down. Timeouts are handled with millisecond precision. If Cancellable.cancel() is called while this is blocking or before this began, an InterruptedException will be thrown.
        Parameters:
        timeout - the operation timeout.
        Returns:
        a connection that can be used to communicate along the given route
        Throws:
        java.util.concurrent.TimeoutException - in case of a timeout
        java.lang.InterruptedException - if the calling thread is interrupted while waiting
        java.util.concurrent.ExecutionException