Package org.apache.pekko.http.javadsl.settings

Interface Http2ClientSettings

All Known Subinterfaces:
Http2ClientSettings
All Known Implementing Classes:
Http2ClientSettings.Http2ClientSettingsImpl
public interface Http2ClientSettings

  • Method Details

    • getBaseConnectionBackoff

      Duration getBaseConnectionBackoff()

    • getCompletionTimeout

      Duration getCompletionTimeout()

    • getMaxConnectionBackoff

      Duration getMaxConnectionBackoff()

    • getMaxPersistentAttempts

      int getMaxPersistentAttempts()

    • getPersistentConnectionMaxAge

      Duration getPersistentConnectionMaxAge()
      The maximum age of a connection created by managedPersistentHttp2 or managedPersistentHttp2WithPriorKnowledge. When the age of a connection exceeds this value, the connection stops accepting new requests, lets requests that are already in flight complete within getCompletionTimeout(), and is then closed. Later requests are sent on a new connection. The value ChronoUnit.FOREVER.getDuration represents an infinite age, which disables this mechanism and is the default.

      Returns:
      (undocumented)
      Since:
      2.0.0

    • getPersistentConnectionMaxAgeJitter

      double getPersistentConnectionMaxAgeJitter()
      The jitter applied to the persistent connection maximum age per connection, as a fraction of the configured age: with the default of 0.1 each connection is retired after between 90% and 110% of the configured age, so that connections that were opened together are not all retired at the same time. 0 disables jitter.

      Returns:
      (undocumented)
      Since:
      2.0.0

    • getPingInterval

      Duration getPingInterval()

    • getPingTimeout

      Duration getPingTimeout()

    • incomingConnectionLevelBufferSize

      int incomingConnectionLevelBufferSize()

    • incomingStreamLevelBufferSize

      int incomingStreamLevelBufferSize()

    • logFrames

      boolean logFrames()

    • maxConcurrentStreams

      int maxConcurrentStreams()

    • maxFrameSize

      int maxFrameSize()
      The largest frame payload this endpoint accepts, in bytes. A larger incoming frame is rejected with a FRAME_SIZE_ERROR on its frame header, before the payload is buffered. No larger SETTINGS_MAX_FRAME_SIZE is advertised, so a peer that follows the spec keeps to the 16 KiB default and the extra room is leniency for peers that do not. RFC 9113, section 4.2 constrains it to be between 16 KiB and 16 MiB - 1.

      Returns:
      (undocumented)
      Since:
      2.0.0

    • maxHeaderListSize

      int maxHeaderListSize()
      The maximum size of a decoded header list that this endpoint is prepared to accept, in bytes. The value is advertised to the peer via SETTINGS_MAX_HEADER_LIST_SIZE and the same limit is applied to the accumulated header block fragments of a HEADERS frame and its CONTINUATION frames.

      Returns:
      (undocumented)
      Since:
      1.4.1

    • outgoingControlFrameBufferSize

      int outgoingControlFrameBufferSize()

    • requestEntityChunkSize

      int requestEntityChunkSize()

    • withBaseConnectionBackoff

      Http2ClientSettings withBaseConnectionBackoff(Duration backoff)

    • withCompletionTimeout

      Http2ClientSettings withCompletionTimeout(Duration timeout)

    • withIncomingConnectionLevelBufferSize

      Http2ClientSettings withIncomingConnectionLevelBufferSize(int newValue)

    • withIncomingStreamLevelBufferSize

      Http2ClientSettings withIncomingStreamLevelBufferSize(int newValue)

    • withLogFrames

      Http2ClientSettings withLogFrames(boolean shouldLog)

    • withMaxConcurrentStreams

      Http2ClientSettings withMaxConcurrentStreams(int newValue)

    • withMaxConnectionBackoff

      Http2ClientSettings withMaxConnectionBackoff(Duration backoff)

    • withMaxFrameSize

      Http2ClientSettings withMaxFrameSize(int newValue)
      Parameters:
      newValue - (undocumented)
      Returns:
      (undocumented)
      Since:
      2.0.0

    • withMaxHeaderListSize

      Http2ClientSettings withMaxHeaderListSize(int newValue)
      Parameters:
      newValue - (undocumented)
      Returns:
      (undocumented)
      Since:
      1.4.1

    • withMaxPersistentAttempts

      Http2ClientSettings withMaxPersistentAttempts(int max)

    • withOutgoingControlFrameBufferSize

      Http2ClientSettings withOutgoingControlFrameBufferSize(int newValue)

    • withPersistentConnectionMaxAge

      Http2ClientSettings withPersistentConnectionMaxAge(Duration maxAge)
      Pass ChronoUnit.FOREVER.getDuration to disable the maximum connection age.

      Parameters:
      maxAge - (undocumented)
      Returns:
      (undocumented)
      Since:
      2.0.0

    • withPersistentConnectionMaxAgeJitter

      Http2ClientSettings withPersistentConnectionMaxAgeJitter(double jitter)
      Parameters:
      jitter - (undocumented)
      Returns:
      (undocumented)
      Since:
      2.0.0

    • withPingInterval

      Http2ClientSettings withPingInterval(Duration interval)

    • withPingTimeout

      Http2ClientSettings withPingTimeout(Duration timeout)

    • withRequestEntityChunkSize

      Http2ClientSettings withRequestEntityChunkSize(int newValue)