Module io.helidon.nima.http2.webserver
Package io.helidon.nima.http2.webserver

Interface Http2Config

@ConfigBean("server.connection-providers.http_2") public interface Http2Config
HTTP/2 server configuration.

  • Method Summary

    Modifier and Type
    Method
    Description
    Duration
    flowControlTimeout()
    Outbound flow control blocking timeout configured as Duration or text in ISO-8601 format.
    int
    initialWindowSize()
    This setting indicates the sender's maximum window size in bytes for connection-level flow control.
    long
    maxConcurrentStreams()
    Maximum number of concurrent streams that the server will allow.
    int
    maxFrameSize()
    The size of the largest frame payload that the sender is willing to receive in bytes.
    long
    maxHeaderListSize()
    The maximum field section size that the sender is prepared to accept in bytes.
    RequestedUriDiscoveryContext
    requestedUriDiscovery()
    Requested URI discovery settings.
    boolean
    sendErrorDetails()
    Whether to send error message over HTTP to client.
    boolean
    validatePath()
    If set to false, any path is accepted (even containing illegal characters).

  • Method Details

    • maxFrameSize

      int maxFrameSize()
      The size of the largest frame payload that the sender is willing to receive in bytes. Default value is 16384 and maximum value is 224-1 = 16777215 bytes. See RFC 9113 section 6.5.2 for details.
      Returns:
      maximal frame size

    • maxHeaderListSize

      long maxHeaderListSize()
      The maximum field section size that the sender is prepared to accept in bytes. See RFC 9113 section 6.5.2 for details. Default is maximal unsigned int.
      Returns:
      maximal header list size in bytes

    • maxConcurrentStreams

      long maxConcurrentStreams()
      Maximum number of concurrent streams that the server will allow. Defaults to 8192. This limit is directional: it applies to the number of streams that the sender permits the receiver to create. It is recommended that this value be no smaller than 100 to not unnecessarily limit parallelism See RFC 9113 section 6.5.2 for details.
      Returns:
      maximal number of concurrent streams

    • initialWindowSize

      int initialWindowSize()
      This setting indicates the sender's maximum window size in bytes for connection-level flow control. Default and maximum value is 231-1 = 2147483647 bytes. This setting affects the window size of HTTP/2 connection. Any value greater than 2147483647 causes an error. Any value smaller than initial window size causes an error. See RFC 9113 section 6.9.1 for details.
      Returns:
      maximum window size in bytes

    • flowControlTimeout

      Duration flowControlTimeout()
      Outbound flow control blocking timeout configured as Duration or text in ISO-8601 format. Blocking timeout defines an interval to wait for the outbound window size changes(incoming window updates) before the next blocking iteration. Default value is PT0.1S.
      ISO_8601 format examples:
      PT0.1S100 milliseconds
      PT0.5S500 milliseconds
      PT2S2 seconds
      Returns:
      duration
      See Also:

    • sendErrorDetails

      boolean sendErrorDetails()
      Whether to send error message over HTTP to client. Defaults to false, as exception message may contain internal information that could be used as an attack vector. Use with care and in cases where both server and clients are under your full control (such as for testing).
      Returns:
      whether to send error messages over the network

    • validatePath

      boolean validatePath()
      If set to false, any path is accepted (even containing illegal characters).
      Returns:
      whether to validate path

    • requestedUriDiscovery

      RequestedUriDiscoveryContext requestedUriDiscovery()
      Requested URI discovery settings.
      Returns:
      settings for computing the requested URI