Class HttpClientConfiguration.Builder

  • Enclosing class:
    HttpClientConfiguration

    public abstract static class HttpClientConfiguration.Builder
    extends java.lang.Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • connectionAcquisitionTimeout

        public abstract HttpClientConfiguration.Builder connectionAcquisitionTimeout​(java.lang.Integer millis)
        Milliseconds to wait when acquiring a connection from the pool before giving up and timing out.
      • connectionMaxIdleTime

        public abstract HttpClientConfiguration.Builder connectionMaxIdleTime​(java.lang.Integer millis)
        Maximum milliseconds a connection should be allowed to remain open while idle.

        This will never close a connection that is currently in use, so long-lived connections may remain open longer than this time.

      • connectionTimeout

        public abstract HttpClientConfiguration.Builder connectionTimeout​(java.lang.Integer millis)
        Milliseconds to wait when initially establishing a connection before giving up and timing out. A duration of 0 means infinity, and is not recommended.
      • connectionTimeToLive

        public abstract HttpClientConfiguration.Builder connectionTimeToLive​(java.lang.Integer millis)
        Maximum milliseconds a connection should be allowed to remain open, regardless of usage frequency.

        This will never close a connection that is currently in use, so long-lived connections may remain open longer than this time.

      • socketTimeout

        public abstract HttpClientConfiguration.Builder socketTimeout​(java.lang.Integer millis)
        Milliseconds to wait for data to be transferred over an established, open connection before the connection is timed out. A duration of 0 means infinity, and is not recommended.
      • readTimeout

        public abstract HttpClientConfiguration.Builder readTimeout​(java.lang.Integer millis)
        Milliseconds to wait for a read on a socket before an exception is thrown. A duration of 0 means infinity, and is not recommended.

        Note: Read timeout is only supported for async clients and ignored otherwise, set socketTimeout(Integer) ()} instead.

      • writeTimeout

        public abstract HttpClientConfiguration.Builder writeTimeout​(java.lang.Integer millis)
        Milliseconds to wait for a write on a socket before an exception is thrown. A duration of 0 means infinity, and is not recommended.

        Note: Write timeout is only supported for async clients and ignored otherwise, set socketTimeout(Integer) ()} instead.

      • maxConnections

        public abstract HttpClientConfiguration.Builder maxConnections​(java.lang.Integer connections)
        The maximum number of connections allowed in the connection pool. Each client has its own private connection pool.

        For asynchronous clients using HTTP/1.1 this corresponds to the maximum number of allowed concurrent requests. When using HTTP/2 the number of connections that will be used depends on the max streams allowed per connection.