Package io.envoyproxy.envoy.config.core.v3

Interface Http3ProtocolOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Http3ProtocolOptions, Http3ProtocolOptions.Builder
public interface Http3ProtocolOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getAllowExtendedConnect()
    Allows proxying Websocket and other upgrades over HTTP/3 CONNECT using the header mechanisms from the `HTTP/2 extended connect RFC <https://datatracker.ietf.org/doc/html/rfc8441>`_ and settings `proposed for HTTP/3 <https://datatracker.ietf.org/doc/draft-ietf-httpbis-h3-websockets/>`_ .. note:: HTTP/3 CONNECT is not yet an RFC.
    boolean
    getAllowMetadata()
    [#not-implemented-hide:] Hiding until Envoy has full metadata support.
    boolean
    getDisableConnectionFlowControlForStreams()
    Disables connection level flow control for HTTP/3 streams.
    boolean
    getDisableQpack()
    [#not-implemented-hide:] Hiding until Envoy has full HTTP/3 upstream support.
    com.google.protobuf.BoolValue
    getOverrideStreamErrorOnInvalidHttpMessage()
    Allows invalid HTTP messaging and headers.
    com.google.protobuf.BoolValueOrBuilder
    getOverrideStreamErrorOnInvalidHttpMessageOrBuilder()
    Allows invalid HTTP messaging and headers.
    QuicProtocolOptions
    getQuicProtocolOptions()
    .envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;
    QuicProtocolOptionsOrBuilder
    getQuicProtocolOptionsOrBuilder()
    .envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;
    boolean
    hasOverrideStreamErrorOnInvalidHttpMessage()
    Allows invalid HTTP messaging and headers.
    boolean
    hasQuicProtocolOptions()
    .envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasQuicProtocolOptions

      boolean hasQuicProtocolOptions()
      .envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;
      Returns:
      Whether the quicProtocolOptions field is set.

    • getQuicProtocolOptions

      QuicProtocolOptions getQuicProtocolOptions()
      .envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;
      Returns:
      The quicProtocolOptions.

    • getQuicProtocolOptionsOrBuilder

      QuicProtocolOptionsOrBuilder getQuicProtocolOptionsOrBuilder()
      .envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;

    • hasOverrideStreamErrorOnInvalidHttpMessage

      boolean hasOverrideStreamErrorOnInvalidHttpMessage()
       Allows invalid HTTP messaging and headers. When this option is disabled (default), then
 the whole HTTP/3 connection is terminated upon receiving invalid HEADERS frame. However,
 when this option is enabled, only the offending stream is terminated.

 If set, this overrides any HCM :ref:`stream_error_on_invalid_http_messaging
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_error_on_invalid_http_message>`.
      .google.protobuf.BoolValue override_stream_error_on_invalid_http_message = 2;
      Returns:
      Whether the overrideStreamErrorOnInvalidHttpMessage field is set.

    • getOverrideStreamErrorOnInvalidHttpMessage

      com.google.protobuf.BoolValue getOverrideStreamErrorOnInvalidHttpMessage()
       Allows invalid HTTP messaging and headers. When this option is disabled (default), then
 the whole HTTP/3 connection is terminated upon receiving invalid HEADERS frame. However,
 when this option is enabled, only the offending stream is terminated.

 If set, this overrides any HCM :ref:`stream_error_on_invalid_http_messaging
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_error_on_invalid_http_message>`.
      .google.protobuf.BoolValue override_stream_error_on_invalid_http_message = 2;
      Returns:
      The overrideStreamErrorOnInvalidHttpMessage.

    • getOverrideStreamErrorOnInvalidHttpMessageOrBuilder

      com.google.protobuf.BoolValueOrBuilder getOverrideStreamErrorOnInvalidHttpMessageOrBuilder()
       Allows invalid HTTP messaging and headers. When this option is disabled (default), then
 the whole HTTP/3 connection is terminated upon receiving invalid HEADERS frame. However,
 when this option is enabled, only the offending stream is terminated.

 If set, this overrides any HCM :ref:`stream_error_on_invalid_http_messaging
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_error_on_invalid_http_message>`.
      .google.protobuf.BoolValue override_stream_error_on_invalid_http_message = 2;

    • getAllowExtendedConnect

      boolean getAllowExtendedConnect()
       Allows proxying Websocket and other upgrades over HTTP/3 CONNECT using
 the header mechanisms from the `HTTP/2 extended connect RFC
 <https://datatracker.ietf.org/doc/html/rfc8441>`_
 and settings `proposed for HTTP/3
 <https://datatracker.ietf.org/doc/draft-ietf-httpbis-h3-websockets/>`_

 .. note::

   HTTP/3 CONNECT is not yet an RFC.
      bool allow_extended_connect = 5 [(.xds.annotations.v3.field_status) = { ... }
      Returns:
      The allowExtendedConnect.

    • getAllowMetadata

      boolean getAllowMetadata()
       [#not-implemented-hide:] Hiding until Envoy has full metadata support.
 Still under implementation. DO NOT USE.

 Allows sending and receiving HTTP/3 METADATA frames. See [metadata
 docs](https://github.com/envoyproxy/envoy/blob/main/source/docs/h2_metadata.md) for more
 information.
      bool allow_metadata = 6;
      Returns:
      The allowMetadata.

    • getDisableQpack

      boolean getDisableQpack()
       [#not-implemented-hide:] Hiding until Envoy has full HTTP/3 upstream support.
 Still under implementation. DO NOT USE.

 Disables QPACK compression related features for HTTP/3 including:
 No huffman encoding, zero dynamic table capacity and no cookie crumbling.
 This can be useful for trading off CPU vs bandwidth when an upstream HTTP/3 connection multiplexes multiple downstream connections.
      bool disable_qpack = 7;
      Returns:
      The disableQpack.

    • getDisableConnectionFlowControlForStreams

      boolean getDisableConnectionFlowControlForStreams()
       Disables connection level flow control for HTTP/3 streams. This is useful in situations where the streams share the same connection
 but originate from different end-clients, so that each stream can make progress independently at non-front-line proxies.
      bool disable_connection_flow_control_for_streams = 8;
      Returns:
      The disableConnectionFlowControlForStreams.