## Uses of Class
org.apache.hc.core5.util.Timeout

- Packages that use Timeout
  Package | Description
  --- | ---
  org.apache.hc.core5.benchmark | Apache Bench (AB) clone based on HttpCore.
  org.apache.hc.core5.http | Core HTTP transport component APIs.
  org.apache.hc.core5.http.config | Core configuration APIs.
  org.apache.hc.core5.http.impl | Default implementations of core HTTP APIs.
  org.apache.hc.core5.http.impl.bootstrap | HTTP/1.1 requester and server bootstrap.
  org.apache.hc.core5.http.impl.io | Default implementation of HTTP/1.1 transport based on the classic (blocking) I/O model.
  org.apache.hc.core5.http.impl.nio | Default implementation of HTTP/1.1 transport based on the asynchronous (non-blocking) I/O model.
  org.apache.hc.core5.http.io | Core HTTP transport APIs based on the classic (blocking) I/O model.
  org.apache.hc.core5.http.nio.ssl | TLS protocol support.
  org.apache.hc.core5.http2.impl.nio | Default implementation of HTTP/2 transport based on the asynchronous (non-blocking) I/O model.
  org.apache.hc.core5.http2.impl.nio.bootstrap | HTTP/2 capable requester and server bootstrap.
  org.apache.hc.core5.http2.nio.pool | HTTP/2 specific pool component APIs.
  org.apache.hc.core5.http2.ssl | HTTP/2 specific TLS protocol support.
  org.apache.hc.core5.io | Core I/O component APIs and utilities.
  org.apache.hc.core5.pool | Client side connection pool component APIs.
  org.apache.hc.core5.reactor | Event driven network communication APIs and components loosely based on Doug Lea's reactor pattern.
  org.apache.hc.core5.reactor.ssl | TLS/SSL support for I/O reactors.
  org.apache.hc.core5.testing.nio |
  org.apache.hc.core5.util | Core utility classes.

- - ### Uses of Timeout in org.apache.hc.core5.benchmark

    Methods in org.apache.hc.core5.benchmark that return Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Timeout` | BenchmarkConfig.`getSocketTimeout()`

    Methods in org.apache.hc.core5.benchmark with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `BenchmarkConfig.Builder` | BenchmarkConfig.Builder.`setSocketTimeout(Timeout socketTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http

    Methods in org.apache.hc.core5.http that return Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Timeout` | SocketModalCloseable.`getSocketTimeout()` Returns the socket timeout value.
    `Timeout` | EndpointDetails.`getSocketTimeout()` Gets the socket timeout.

    Methods in org.apache.hc.core5.http with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `void` | SocketModalCloseable.`setSocketTimeout(Timeout timeout)` Sets the socket timeout value.

    Constructors in org.apache.hc.core5.http with parameters of type Timeout
    Constructor and Description
    `EndpointDetails(SocketAddress remoteAddress, SocketAddress localAddress, Timeout socketTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http.config

    Methods in org.apache.hc.core5.http.config that return Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Timeout` | Http1Config.`getWaitForContinueTimeout()`

    Methods in org.apache.hc.core5.http.config with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Http1Config.Builder` | Http1Config.Builder.`setWaitForContinueTimeout(Timeout waitForContinueTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http.impl

    Constructors in org.apache.hc.core5.http.impl with parameters of type Timeout
    Constructor and Description
    `BasicEndpointDetails(SocketAddress remoteAddress, SocketAddress localAddress, HttpConnectionMetrics metrics, Timeout socketTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http.impl.bootstrap

    Methods in org.apache.hc.core5.http.impl.bootstrap with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Future<AsyncClientEndpoint>` | HttpAsyncRequester.`connect(HttpHost host, Timeout timeout)`
    `Future<AsyncClientEndpoint>` | HttpAsyncRequester.`connect(HttpHost host, Timeout timeout, Object attachment, FutureCallback<AsyncClientEndpoint> callback)`
    `protected Future<AsyncClientEndpoint>` | HttpAsyncRequester.`doConnect(HttpHost host, Timeout timeout, Object attachment, FutureCallback<AsyncClientEndpoint> callback)`
    `void` | HttpAsyncRequester.`execute(AsyncClientExchangeHandler exchangeHandler, HandlerFactory<AsyncPushConsumer> pushHandlerFactory, Timeout timeout, HttpContext executeContext)`
    `void` | HttpAsyncRequester.`execute(AsyncClientExchangeHandler exchangeHandler, Timeout timeout, HttpContext executeContext)`
    `<T> Future<T>` | HttpAsyncRequester.`execute(AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, HandlerFactory<AsyncPushConsumer> pushHandlerFactory, Timeout timeout, HttpContext context, FutureCallback<T> callback)`
    `<T> Future<T>` | HttpAsyncRequester.`execute(AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, Timeout timeout, FutureCallback<T> callback)`
    `<T> Future<T>` | HttpAsyncRequester.`execute(AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, Timeout timeout, HttpContext context, FutureCallback<T> callback)`
    `ClassicHttpResponse` | HttpRequester.`execute(HttpHost targetHost, ClassicHttpRequest request, HttpResponseInformationCallback informationCallback, Timeout connectTimeout, HttpContext context)`
    `ClassicHttpResponse` | HttpRequester.`execute(HttpHost targetHost, ClassicHttpRequest request, Timeout connectTimeout, HttpContext context)`
    `<T> T` | HttpRequester.`execute(HttpHost targetHost, ClassicHttpRequest request, Timeout connectTimeout, HttpContext context, HttpClientResponseHandler<T> responseHandler)`
    `Future<IOSession>` | AsyncRequester.`requestSession(HttpHost host, Timeout timeout, Object attachment, FutureCallback<IOSession> callback)`
    `AsyncRequesterBootstrap` | AsyncRequesterBootstrap.`setTimeToLive(Timeout timeToLive)`
    `RequesterBootstrap` | RequesterBootstrap.`setTimeToLive(Timeout timeToLive)`
    `AsyncServerBootstrap` | AsyncServerBootstrap.`setTlsHandshakeTimeout(Timeout handshakeTimeout)` Assigns TLS handshake `Timeout`.
    `AsyncRequesterBootstrap` | AsyncRequesterBootstrap.`setTlsHandshakeTimeout(Timeout handshakeTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http.impl.io

    Fields in org.apache.hc.core5.http.impl.io declared as Timeout
    Modifier and Type | Field and Description
    --- | ---
    `static Timeout` | HttpRequestExecutor.`DEFAULT_WAIT_FOR_CONTINUE`

    Constructors in org.apache.hc.core5.http.impl.io with parameters of type Timeout
    Constructor and Description
    `HttpRequestExecutor(Timeout waitForContinue, ConnectionReuseStrategy connReuseStrategy, Http1StreamListener streamListener)` Creates new instance of HttpRequestExecutor.

  - ### Uses of Timeout in org.apache.hc.core5.http.impl.nio

    Constructors in org.apache.hc.core5.http.impl.nio with parameters of type Timeout
    Constructor and Description
    `ClientHttp1IOEventHandlerFactory(ClientHttp1StreamDuplexerFactory streamDuplexerFactory, TlsStrategy tlsStrategy, Timeout handshakeTimeout)`
    `ServerHttp1IOEventHandlerFactory(ServerHttp1StreamDuplexerFactory streamDuplexerFactory, TlsStrategy tlsStrategy, Timeout handshakeTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http.io

    Methods in org.apache.hc.core5.http.io that return Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Timeout` | SocketConfig.`getSoTimeout()`

    Methods in org.apache.hc.core5.http.io with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | BHttpConnection.`isDataAvailable(Timeout timeout)` Checks if input data is available from the connection.
    `SocketConfig.Builder` | SocketConfig.Builder.`setSoTimeout(Timeout soTimeout)` Determines the default socket timeout value for blocking I/O operations.

  - ### Uses of Timeout in org.apache.hc.core5.http.nio.ssl

    Methods in org.apache.hc.core5.http.nio.ssl with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | TlsStrategy.`upgrade(TransportSecurityLayer sessionLayer, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout)` Secures current session layer with TLS security.
    `boolean` | BasicClientTlsStrategy.`upgrade(TransportSecurityLayer tlsSession, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout)`
    `boolean` | BasicServerTlsStrategy.`upgrade(TransportSecurityLayer tlsSession, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http2.impl.nio

    Constructors in org.apache.hc.core5.http2.impl.nio with parameters of type Timeout
    Constructor and Description
    `ClientHttpProtocolNegotiatorFactory(ClientHttp1StreamDuplexerFactory http1StreamHandlerFactory, ClientH2StreamMultiplexerFactory http2StreamHandlerFactory, HttpVersionPolicy versionPolicy, TlsStrategy tlsStrategy, Timeout handshakeTimeout)`
    `ServerHttpProtocolNegotiatorFactory(ServerHttp1StreamDuplexerFactory http1StreamDuplexerFactory, ServerH2StreamMultiplexerFactory http2StreamMultiplexerFactory, HttpVersionPolicy versionPolicy, TlsStrategy tlsStrategy, Timeout handshakeTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http2.impl.nio.bootstrap

    Methods in org.apache.hc.core5.http2.impl.nio.bootstrap with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `protected Future<AsyncClientEndpoint>` | H2AsyncRequester.`doConnect(HttpHost host, Timeout timeout, Object attachment, FutureCallback<AsyncClientEndpoint> callback)`
    `Cancellable` | H2MultiplexingRequester.`execute(AsyncClientExchangeHandler exchangeHandler, HandlerFactory<AsyncPushConsumer> pushHandlerFactory, Timeout timeout, HttpContext context)`
    `Cancellable` | H2MultiplexingRequester.`execute(AsyncClientExchangeHandler exchangeHandler, Timeout timeout, HttpContext context)`
    `<T> Future<T>` | H2MultiplexingRequester.`execute(AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, HandlerFactory<AsyncPushConsumer> pushHandlerFactory, Timeout timeout, HttpContext context, FutureCallback<T> callback)`
    `<T> Future<T>` | H2MultiplexingRequester.`execute(AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, Timeout timeout, FutureCallback<T> callback)`
    `<T> Future<T>` | H2MultiplexingRequester.`execute(AsyncRequestProducer requestProducer, AsyncResponseConsumer<T> responseConsumer, Timeout timeout, HttpContext context, FutureCallback<T> callback)`
    `H2RequesterBootstrap` | H2RequesterBootstrap.`setHandshakeTimeout(Timeout handshakeTimeout)`
    `H2ServerBootstrap` | H2ServerBootstrap.`setHandshakeTimeout(Timeout handshakeTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.http2.nio.pool

    Methods in org.apache.hc.core5.http2.nio.pool with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `protected Future<IOSession>` | H2ConnPool.`connectSession(HttpHost namedEndpoint, Timeout connectTimeout, FutureCallback<IOSession> callback)`

  - ### Uses of Timeout in org.apache.hc.core5.http2.ssl

    Methods in org.apache.hc.core5.http2.ssl with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | ConscryptServerTlsStrategy.`upgrade(TransportSecurityLayer tlsSession, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout)`
    `boolean` | ConscryptClientTlsStrategy.`upgrade(TransportSecurityLayer tlsSession, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout)`
    `boolean` | H2ServerTlsStrategy.`upgrade(TransportSecurityLayer tlsSession, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout)`
    `boolean` | H2ClientTlsStrategy.`upgrade(TransportSecurityLayer tlsSession, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout)`

  - ### Uses of Timeout in org.apache.hc.core5.io

    Methods in org.apache.hc.core5.io with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `static SocketTimeoutException` | SocketTimeoutExceptionFactory.`create(Timeout timeout)` Creates a new `SocketTimeoutException` with a message for the given timeout.

  - ### Uses of Timeout in org.apache.hc.core5.pool

    Methods in org.apache.hc.core5.pool with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Future<PoolEntry<T,C>>` | StrictConnPool.`lease(T route, Object state, Timeout requestTimeout, FutureCallback<PoolEntry<T,C>> callback)`
    `Future<PoolEntry<T,C>>` | ConnPool.`lease(T route, Object state, Timeout requestTimeout, FutureCallback<PoolEntry<T,C>> callback)` Attempts to lease a connection for the given route and with the given state from the pool.
    `Future<PoolEntry<T,C>>` | LaxConnPool.`lease(T route, Object state, Timeout requestTimeout, FutureCallback<PoolEntry<T,C>> callback)`

  - ### Uses of Timeout in org.apache.hc.core5.reactor

    Methods in org.apache.hc.core5.reactor that return Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Timeout` | IOSession.`getSocketTimeout()` Returns value of the socket timeout in milliseconds.
    `Timeout` | IOReactorConfig.`getSoTimeout()`

    Methods in org.apache.hc.core5.reactor with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Future<IOSession>` | ConnectionInitiator.`connect(NamedEndpoint remoteEndpoint, SocketAddress remoteAddress, SocketAddress localAddress, Timeout timeout, Object attachment, FutureCallback<IOSession> callback)` Requests a connection to a remote host.
    `protected abstract Future<IOSession>` | AbstractIOSessionPool.`connectSession(T namedEndpoint, Timeout connectTimeout, FutureCallback<IOSession> callback)`
    `Future<IOSession>` | AbstractIOSessionPool.`getSession(T endpoint, Timeout connectTimeout, FutureCallback<IOSession> callback)`
    `void` | IOSession.`setSocketTimeout(Timeout timeout)` Sets value of the socket timeout in milliseconds.
    `IOReactorConfig.Builder` | IOReactorConfig.Builder.`setSoTimeout(Timeout soTimeout)` Determines the default socket timeout value for non-blocking I/O operations.
    `void` | IOEventHandler.`timeout(IOSession session, Timeout timeout)` Triggered when the given session has timed out.

  - ### Uses of Timeout in org.apache.hc.core5.reactor.ssl

    Methods in org.apache.hc.core5.reactor.ssl that return Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Timeout` | SSLIOSession.`getSocketTimeout()`

    Methods in org.apache.hc.core5.reactor.ssl with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `void` | SSLIOSession.`setSocketTimeout(Timeout timeout)`
    `void` | TransportSecurityLayer.`startTls(SSLContext sslContext, NamedEndpoint endpoint, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier, Timeout handshakeTimeout)` Starts TLS session over an existing network connection with the given SSL context.

    Constructors in org.apache.hc.core5.reactor.ssl with parameters of type Timeout
    Constructor and Description
    `SSLIOSession(NamedEndpoint targetEndpoint, IOSession session, SSLMode sslMode, SSLContext sslContext, SSLBufferMode sslBufferMode, SSLSessionInitializer initializer, SSLSessionVerifier verifier, Callback<SSLIOSession> sessionStartCallback, Callback<SSLIOSession> sessionEndCallback, Timeout connectTimeout)` Creates new instance of `SSLIOSession` class.

  - ### Uses of Timeout in org.apache.hc.core5.testing.nio

    Methods in org.apache.hc.core5.testing.nio that return Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Timeout` | LoggingIOSession.`getSocketTimeout()`

    Methods in org.apache.hc.core5.testing.nio with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `Future<ClientSessionEndpoint>` | H2TestClient.`connect(HttpHost host, Timeout timeout)`
    `Future<ClientSessionEndpoint>` | Http1TestClient.`connect(HttpHost host, Timeout timeout)`
    `Future<ClientSessionEndpoint>` | H2TestClient.`connect(HttpHost host, Timeout timeout, FutureCallback<ClientSessionEndpoint> callback)`
    `Future<ClientSessionEndpoint>` | Http1TestClient.`connect(HttpHost host, Timeout timeout, FutureCallback<ClientSessionEndpoint> callback)`
    `Future<IOSession>` | AsyncRequester.`connect(NamedEndpoint remoteEndpoint, SocketAddress remoteAddress, SocketAddress localAddress, Timeout timeout, Object attachment, FutureCallback<IOSession> callback)`
    `Future<ClientSessionEndpoint>` | H2TestClient.`connect(String hostname, int port, Timeout timeout)`
    `Future<ClientSessionEndpoint>` | Http1TestClient.`connect(String hostname, int port, Timeout timeout)`
    `Future<IOSession>` | AsyncRequester.`requestSession(HttpHost host, Timeout timeout, FutureCallback<IOSession> callback)`
    `void` | LoggingIOSession.`setSocketTimeout(Timeout timeout)`

  - ### Uses of Timeout in org.apache.hc.core5.util

    Fields in org.apache.hc.core5.util declared as Timeout
    Modifier and Type | Field and Description
    --- | ---
    `static Timeout` | Timeout.`DISABLED` A disabled timeout represented as 0 `MILLISECONDS`.
    `static Timeout` | Timeout.`ONE_MILLISECOND` A one milliseconds `Timeout`.
    `static Timeout` | Timeout.`ZERO_MILLISECONDS` A zero milliseconds `Timeout`.

    Methods in org.apache.hc.core5.util that return Timeout
    Modifier and Type | Method and Description
    --- | ---
    `static Timeout` | Timeout.`defaultsToDisabled(Timeout timeout)` Returns the given `timeout` if it is not `null`, if `null` then returns `DISABLED`.
    `Timeout` | TimeoutValueException.`getActual()` Gets how long was the expected timeout in milliseconds.
    `Timeout` | TimeoutValueException.`getDeadline()` Gets how long we actually waited in milliseconds.
    `static Timeout` | Timeout.`of(long duration, TimeUnit timeUnit)` Creates a Timeout.
    `static Timeout` | Timeout.`ofDays(long days)` Creates a Timeout.
    `static Timeout` | Timeout.`ofHours(long hours)` Creates a Timeout.
    `static Timeout` | Timeout.`ofMicroseconds(long microseconds)` Creates a Timeout.
    `static Timeout` | Timeout.`ofMilliseconds(long milliseconds)` Creates a Timeout.
    `static Timeout` | Timeout.`ofMinutes(long minutes)` Creates a Timeout.
    `static Timeout` | Timeout.`ofNanoseconds(long nanoseconds)` Creates a Timeout.
    `static Timeout` | Timeout.`ofSeconds(long seconds)` Creates a Timeout.
    `static Timeout` | Timeout.`parse(String value)` Parses a Timeout in the format `<Integer><SPACE><TimeUnit>`, for example `"1,200 MILLISECONDS"`
    `Timeout` | TimeValue.`toTimeout()`

    Methods in org.apache.hc.core5.util with parameters of type Timeout
    Modifier and Type | Method and Description
    --- | ---
    `static Timeout` | Timeout.`defaultsToDisabled(Timeout timeout)` Returns the given `timeout` if it is not `null`, if `null` then returns `DISABLED`.

    Constructors in org.apache.hc.core5.util with parameters of type Timeout
    Constructor and Description
    `TimeoutValueException(Timeout deadline, Timeout actual)` Creates a new exception for the given timeout deadline and actual timeout.

Copyright © 2005–2021 The Apache Software Foundation. All rights reserved.