| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| Timeout | BenchmarkConfig. getSocketTimeout() | 
| Modifier and Type | Method and Description | 
|---|---|
| BenchmarkConfig.Builder | BenchmarkConfig.Builder. setSocketTimeout(Timeout socketTimeout) | 
| Modifier and Type | Method and Description | 
|---|---|
| Timeout | SocketModalCloseable. getSocketTimeout()Returns the socket timeout value. | 
| Timeout | EndpointDetails. getSocketTimeout()Gets the socket timeout. | 
| Modifier and Type | Method and Description | 
|---|---|
| void | SocketModalCloseable. setSocketTimeout(Timeout timeout)Sets the socket timeout value. | 
| Constructor and Description | 
|---|
| EndpointDetails(SocketAddress remoteAddress,
               SocketAddress localAddress,
               Timeout socketTimeout) | 
| Modifier and Type | Method and Description | 
|---|---|
| Timeout | Http1Config. getWaitForContinueTimeout() | 
| Modifier and Type | Method and Description | 
|---|---|
| Http1Config.Builder | Http1Config.Builder. setWaitForContinueTimeout(Timeout waitForContinueTimeout) | 
| Constructor and Description | 
|---|
| BasicEndpointDetails(SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    HttpConnectionMetrics metrics,
                    Timeout socketTimeout) | 
| Modifier and Type | Method and Description | 
|---|---|
| void | HttpServer. close(CloseMode closeMode,
     Timeout timeout)Closes this process or endpoint and releases any system resources associated
 with it. | 
| 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) | 
| void | HttpAsyncRequester. execute(HttpHost target,
       AsyncClientExchangeHandler exchangeHandler,
       HandlerFactory<AsyncPushConsumer> pushHandlerFactory,
       Timeout timeout,
       HttpContext executeContext) | 
| <T> Future<T> | HttpAsyncRequester. execute(HttpHost target,
       AsyncRequestProducer requestProducer,
       AsyncResponseConsumer<T> responseConsumer,
       HandlerFactory<AsyncPushConsumer> pushHandlerFactory,
       Timeout timeout,
       HttpContext context,
       FutureCallback<T> callback) | 
| <T> Future<T> | HttpAsyncRequester. execute(HttpHost target,
       AsyncRequestProducer requestProducer,
       AsyncResponseConsumer<T> responseConsumer,
       Timeout timeout,
       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) | 
| AsyncRequesterBootstrap | AsyncRequesterBootstrap. setTlsHandshakeTimeout(Timeout handshakeTimeout) | 
| AsyncServerBootstrap | AsyncServerBootstrap. setTlsHandshakeTimeout(Timeout handshakeTimeout)Sets TLS handshake  Timeout. | 
| Constructor and Description | 
|---|
| HttpAsyncRequester(IOReactorConfig ioReactorConfig,
                  IOEventHandlerFactory eventHandlerFactory,
                  Decorator<IOSession> ioSessionDecorator,
                  Callback<Exception> exceptionCallback,
                  IOSessionListener sessionListener,
                  ManagedConnPool<HttpHost,IOSession> connPool,
                  TlsStrategy tlsStrategy,
                  Timeout handshakeTimeout)Use  AsyncRequesterBootstrapto create instances of this class. | 
| Modifier and Type | Field and Description | 
|---|---|
| static Timeout | HttpRequestExecutor. DEFAULT_WAIT_FOR_CONTINUE | 
| Modifier and Type | Method and Description | 
|---|---|
| HttpRequestExecutor.Builder | HttpRequestExecutor.Builder. withWaitForContinue(Timeout waitForContinue) | 
| Constructor and Description | 
|---|
| HttpRequestExecutor(Timeout waitForContinue,
                   ConnectionReuseStrategy connReuseStrategy,
                   Http1StreamListener streamListener) | 
| Constructor and Description | 
|---|
| ClientHttp1IOEventHandlerFactory(ClientHttp1StreamDuplexerFactory streamDuplexerFactory,
                                TlsStrategy tlsStrategy,
                                Timeout handshakeTimeout) | 
| ServerHttp1IOEventHandlerFactory(ServerHttp1StreamDuplexerFactory streamDuplexerFactory,
                                TlsStrategy tlsStrategy,
                                Timeout handshakeTimeout) | 
| Modifier and Type | Method and Description | 
|---|---|
| Timeout | SocketConfig. getSoTimeout() | 
| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | BasicClientTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       HttpHost host,
       SocketAddress localAddress,
       SocketAddress remoteAddress,
       Object attachment,
       Timeout handshakeTimeout) | 
| boolean | TlsStrategy. upgrade(TransportSecurityLayer sessionLayer,
       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) | 
| void | BasicClientTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       NamedEndpoint endpoint,
       Object attachment,
       Timeout handshakeTimeout,
       FutureCallback<TransportSecurityLayer> callback) | 
| default void | TlsStrategy. upgrade(TransportSecurityLayer sessionLayer,
       NamedEndpoint endpoint,
       Object attachment,
       Timeout handshakeTimeout,
       FutureCallback<TransportSecurityLayer> callback)Secures current session layer with TLS. | 
| void | BasicServerTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       NamedEndpoint endpoint,
       Object attachment,
       Timeout handshakeTimeout,
       FutureCallback<TransportSecurityLayer> callback) | 
| Modifier and Type | Method and Description | 
|---|---|
| Timeout | HttpProtocolNegotiator. getSocketTimeout() | 
| Modifier and Type | Method and Description | 
|---|---|
| void | HttpProtocolNegotiator. setSocketTimeout(Timeout timeout) | 
| void | HttpProtocolNegotiator. timeout(IOSession session,
       Timeout timeout) | 
| Constructor and Description | 
|---|
| ClientHttpProtocolNegotiationStarter(ClientHttp1StreamDuplexerFactory http1StreamHandlerFactory,
                                    ClientH2StreamMultiplexerFactory http2StreamHandlerFactory,
                                    HttpVersionPolicy versionPolicy,
                                    TlsStrategy tlsStrategy,
                                    Timeout handshakeTimeout) | 
| ServerHttpProtocolNegotiationStarter(ServerHttp1StreamDuplexerFactory http1StreamHandlerFactory,
                                    ServerH2StreamMultiplexerFactory http2StreamHandlerFactory,
                                    HttpVersionPolicy versionPolicy,
                                    TlsStrategy tlsStrategy,
                                    Timeout handshakeTimeout) | 
| 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) | 
| Cancellable | H2MultiplexingRequester. execute(HttpHost target,
       AsyncClientExchangeHandler exchangeHandler,
       HandlerFactory<AsyncPushConsumer> pushHandlerFactory,
       Timeout timeout,
       HttpContext context) | 
| Cancellable | H2MultiplexingRequester. execute(HttpHost target,
       AsyncClientExchangeHandler exchangeHandler,
       Timeout timeout,
       HttpContext context) | 
| <T> Future<T> | H2MultiplexingRequester. execute(HttpHost target,
       AsyncRequestProducer requestProducer,
       AsyncResponseConsumer<T> responseConsumer,
       HandlerFactory<AsyncPushConsumer> pushHandlerFactory,
       Timeout timeout,
       HttpContext context,
       FutureCallback<T> callback) | 
| <T> Future<T> | H2MultiplexingRequester. execute(HttpHost target,
       AsyncRequestProducer requestProducer,
       AsyncResponseConsumer<T> responseConsumer,
       Timeout timeout,
       HttpContext context,
       FutureCallback<T> callback) | 
| H2RequesterBootstrap | H2RequesterBootstrap. setHandshakeTimeout(Timeout handshakeTimeout) | 
| H2ServerBootstrap | H2ServerBootstrap. setHandshakeTimeout(Timeout handshakeTimeout) | 
| Constructor and Description | 
|---|
| H2AsyncRequester(HttpVersionPolicy versionPolicy,
                IOReactorConfig ioReactorConfig,
                IOEventHandlerFactory eventHandlerFactory,
                Decorator<IOSession> ioSessionDecorator,
                Callback<Exception> exceptionCallback,
                IOSessionListener sessionListener,
                ManagedConnPool<HttpHost,IOSession> connPool,
                TlsStrategy tlsStrategy,
                Timeout handshakeTimeout)Use  H2RequesterBootstrapto create instances of this class. | 
| Modifier and Type | Method and Description | 
|---|---|
| protected Future<IOSession> | H2ConnPool. connectSession(HttpHost namedEndpoint,
              Timeout connectTimeout,
              FutureCallback<IOSession> callback) | 
| Modifier and Type | Method and Description | 
|---|---|
| boolean | H2ServerTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       HttpHost host,
       SocketAddress localAddress,
       SocketAddress remoteAddress,
       Object attachment,
       Timeout handshakeTimeout) | 
| boolean | ConscryptServerTlsStrategy. 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) | 
| boolean | ConscryptClientTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       HttpHost host,
       SocketAddress localAddress,
       SocketAddress remoteAddress,
       Object attachment,
       Timeout handshakeTimeout) | 
| void | H2ServerTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       NamedEndpoint endpoint,
       Object attachment,
       Timeout handshakeTimeout,
       FutureCallback<TransportSecurityLayer> callback) | 
| void | ConscryptServerTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       NamedEndpoint endpoint,
       Object attachment,
       Timeout handshakeTimeout,
       FutureCallback<TransportSecurityLayer> callback) | 
| void | H2ClientTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       NamedEndpoint endpoint,
       Object attachment,
       Timeout handshakeTimeout,
       FutureCallback<TransportSecurityLayer> callback) | 
| void | ConscryptClientTlsStrategy. upgrade(TransportSecurityLayer tlsSession,
       NamedEndpoint endpoint,
       Object attachment,
       Timeout handshakeTimeout,
       FutureCallback<TransportSecurityLayer> callback) | 
| Modifier and Type | Method and Description | 
|---|---|
| static SocketTimeoutException | SocketTimeoutExceptionFactory. create(Timeout timeout)Creates a new  SocketTimeoutExceptionwith a message for the given timeout. | 
| Modifier and Type | Method and Description | 
|---|---|
| Future<PoolEntry<T,C>> | LaxConnPool. lease(T route,
     Object state,
     Timeout requestTimeout,
     FutureCallback<PoolEntry<T,C>> callback) | 
| 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| Timeout | IOSession. getSocketTimeout()Returns value of the socket timeout in milliseconds. | 
| Timeout | IOReactorConfig. getSoTimeout() | 
| 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)Sets 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. | 
| Modifier and Type | Method and Description | 
|---|---|
| Timeout | SSLIOSession. getSocketTimeout() | 
| 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. | 
| default void | TransportSecurityLayer. startTls(SSLContext sslContext,
        NamedEndpoint endpoint,
        SSLBufferMode sslBufferMode,
        SSLSessionInitializer initializer,
        SSLSessionVerifier verifier,
        Timeout handshakeTimeout,
        FutureCallback<TransportSecurityLayer> callback)Starts TLS session over an existing network connection with the given SSL context. | 
| 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  SSLIOSessionclass. | 
| SSLIOSession(NamedEndpoint targetEndpoint,
            IOSession session,
            SSLMode sslMode,
            SSLContext sslContext,
            SSLBufferMode sslBufferMode,
            SSLSessionInitializer initializer,
            SSLSessionVerifier verifier,
            Timeout handshakeTimeout,
            Callback<SSLIOSession> sessionStartCallback,
            Callback<SSLIOSession> sessionEndCallback,
            FutureCallback<SSLSession> resultCallback)Creates new instance of  SSLIOSessionclass. | 
| Modifier and Type | Method and Description | 
|---|---|
| Timeout | LoggingIOSession. getSocketTimeout() | 
| Modifier and Type | Field and Description | 
|---|---|
| static Timeout | Timeout. DISABLEDA disabled timeout represented as 0  MILLISECONDS. | 
| static Timeout | Timeout. INFINITEAn infinite timeout represented as 0  MILLISECONDS. | 
| static Timeout | Timeout. ONE_MILLISECONDA one milliseconds  Timeout. | 
| static Timeout | Timeout. ZERO_MILLISECONDSA zero milliseconds  Timeout. | 
| Modifier and Type | Method and Description | 
|---|---|
| static Timeout | Timeout. defaultsToDisabled(Timeout timeout) | 
| static Timeout | Timeout. defaultsToInfinite(Timeout timeout) | 
| 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(Duration duration)Creates a Timeout from a Duration. | 
| 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() | 
| Modifier and Type | Method and Description | 
|---|---|
| static Timeout | Timeout. defaultsToDisabled(Timeout timeout) | 
| static Timeout | Timeout. defaultsToInfinite(Timeout 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.