Interface Http2ProtocolOptionsOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
Http2ProtocolOptions
,Http2ProtocolOptions.Builder
public interface Http2ProtocolOptionsOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Allows proxying Websocket and other upgrades over H2 connect.boolean
[#not-implemented-hide:] Hiding until Envoy has full metadata support.Send HTTP/2 PING frames to verify that the connection is still healthy.Send HTTP/2 PING frames to verify that the connection is still healthy.getCustomSettingsParameters
(int index) [#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1.int
[#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1.[#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1.getCustomSettingsParametersOrBuilder
(int index) [#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1.[#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1.com.google.protobuf.UInt32Value
`Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_ (in octets) that the encoder is permitted to use for the dynamic HPACK table.com.google.protobuf.UInt32ValueOrBuilder
`Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_ (in octets) that the encoder is permitted to use for the dynamic HPACK table.com.google.protobuf.UInt32Value
Similar to ``initial_stream_window_size``, but for connection-level flow-control window.com.google.protobuf.UInt32ValueOrBuilder
Similar to ``initial_stream_window_size``, but for connection-level flow-control window.com.google.protobuf.UInt32Value
`Initial stream-level flow-control window <https://httpwg.org/specs/rfc7540.html#rfc.section.6.9.2>`_ size.com.google.protobuf.UInt32ValueOrBuilder
`Initial stream-level flow-control window <https://httpwg.org/specs/rfc7540.html#rfc.section.6.9.2>`_ size.com.google.protobuf.UInt32Value
`Maximum concurrent streams <https://httpwg.org/specs/rfc7540.html#rfc.section.5.1.2>`_ allowed for peer on one HTTP/2 connection.com.google.protobuf.UInt32ValueOrBuilder
`Maximum concurrent streams <https://httpwg.org/specs/rfc7540.html#rfc.section.5.1.2>`_ allowed for peer on one HTTP/2 connection.com.google.protobuf.UInt32Value
Limit the number of consecutive inbound frames of types HEADERS, CONTINUATION and DATA with an empty payload and no end stream flag.com.google.protobuf.UInt32ValueOrBuilder
Limit the number of consecutive inbound frames of types HEADERS, CONTINUATION and DATA with an empty payload and no end stream flag.com.google.protobuf.UInt32Value
Limit the number of inbound PRIORITY frames allowed per each opened stream.com.google.protobuf.UInt32ValueOrBuilder
Limit the number of inbound PRIORITY frames allowed per each opened stream.com.google.protobuf.UInt32Value
Limit the number of inbound WINDOW_UPDATE frames allowed per DATA frame sent.com.google.protobuf.UInt32ValueOrBuilder
Limit the number of inbound WINDOW_UPDATE frames allowed per DATA frame sent.com.google.protobuf.UInt32Value
Limit the number of pending outbound downstream frames of types PING, SETTINGS and RST_STREAM, preventing high memory utilization when receiving continuous stream of these frames.com.google.protobuf.UInt32ValueOrBuilder
Limit the number of pending outbound downstream frames of types PING, SETTINGS and RST_STREAM, preventing high memory utilization when receiving continuous stream of these frames.com.google.protobuf.UInt32Value
Limit the number of pending outbound downstream frames of all types (frames that are waiting to be written into the socket).com.google.protobuf.UInt32ValueOrBuilder
Limit the number of pending outbound downstream frames of all types (frames that are waiting to be written into the socket).com.google.protobuf.BoolValue
Allows invalid HTTP messaging and headers.com.google.protobuf.BoolValueOrBuilder
Allows invalid HTTP messaging and headers.boolean
Deprecated.envoy.config.core.v3.Http2ProtocolOptions.stream_error_on_invalid_http_messaging is deprecated.com.google.protobuf.BoolValue
[#not-implemented-hide:] Hiding so that the field can be removed after oghttp2 is rolled out.com.google.protobuf.BoolValueOrBuilder
[#not-implemented-hide:] Hiding so that the field can be removed after oghttp2 is rolled out.boolean
Send HTTP/2 PING frames to verify that the connection is still healthy.boolean
`Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_ (in octets) that the encoder is permitted to use for the dynamic HPACK table.boolean
Similar to ``initial_stream_window_size``, but for connection-level flow-control window.boolean
`Initial stream-level flow-control window <https://httpwg.org/specs/rfc7540.html#rfc.section.6.9.2>`_ size.boolean
`Maximum concurrent streams <https://httpwg.org/specs/rfc7540.html#rfc.section.5.1.2>`_ allowed for peer on one HTTP/2 connection.boolean
Limit the number of consecutive inbound frames of types HEADERS, CONTINUATION and DATA with an empty payload and no end stream flag.boolean
Limit the number of inbound PRIORITY frames allowed per each opened stream.boolean
Limit the number of inbound WINDOW_UPDATE frames allowed per DATA frame sent.boolean
Limit the number of pending outbound downstream frames of types PING, SETTINGS and RST_STREAM, preventing high memory utilization when receiving continuous stream of these frames.boolean
Limit the number of pending outbound downstream frames of all types (frames that are waiting to be written into the socket).boolean
Allows invalid HTTP messaging and headers.boolean
[#not-implemented-hide:] Hiding so that the field can be removed after oghttp2 is rolled out.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
-
hasHpackTableSize
boolean hasHpackTableSize()`Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_ (in octets) that the encoder is permitted to use for the dynamic HPACK table. Valid values range from 0 to 4294967295 (2^32 - 1) and defaults to 4096. 0 effectively disables header compression.
.google.protobuf.UInt32Value hpack_table_size = 1;
- Returns:
- Whether the hpackTableSize field is set.
-
getHpackTableSize
com.google.protobuf.UInt32Value getHpackTableSize()`Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_ (in octets) that the encoder is permitted to use for the dynamic HPACK table. Valid values range from 0 to 4294967295 (2^32 - 1) and defaults to 4096. 0 effectively disables header compression.
.google.protobuf.UInt32Value hpack_table_size = 1;
- Returns:
- The hpackTableSize.
-
getHpackTableSizeOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getHpackTableSizeOrBuilder()`Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_ (in octets) that the encoder is permitted to use for the dynamic HPACK table. Valid values range from 0 to 4294967295 (2^32 - 1) and defaults to 4096. 0 effectively disables header compression.
.google.protobuf.UInt32Value hpack_table_size = 1;
-
hasMaxConcurrentStreams
boolean hasMaxConcurrentStreams()`Maximum concurrent streams <https://httpwg.org/specs/rfc7540.html#rfc.section.5.1.2>`_ allowed for peer on one HTTP/2 connection. Valid values range from 1 to 2147483647 (2^31 - 1) and defaults to 2147483647. For upstream connections, this also limits how many streams Envoy will initiate concurrently on a single connection. If the limit is reached, Envoy may queue requests or establish additional connections (as allowed per circuit breaker limits). This acts as an upper bound: Envoy will lower the max concurrent streams allowed on a given connection based on upstream settings. Config dumps will reflect the configured upper bound, not the per-connection negotiated limits.
.google.protobuf.UInt32Value max_concurrent_streams = 2 [(.validate.rules) = { ... }
- Returns:
- Whether the maxConcurrentStreams field is set.
-
getMaxConcurrentStreams
com.google.protobuf.UInt32Value getMaxConcurrentStreams()`Maximum concurrent streams <https://httpwg.org/specs/rfc7540.html#rfc.section.5.1.2>`_ allowed for peer on one HTTP/2 connection. Valid values range from 1 to 2147483647 (2^31 - 1) and defaults to 2147483647. For upstream connections, this also limits how many streams Envoy will initiate concurrently on a single connection. If the limit is reached, Envoy may queue requests or establish additional connections (as allowed per circuit breaker limits). This acts as an upper bound: Envoy will lower the max concurrent streams allowed on a given connection based on upstream settings. Config dumps will reflect the configured upper bound, not the per-connection negotiated limits.
.google.protobuf.UInt32Value max_concurrent_streams = 2 [(.validate.rules) = { ... }
- Returns:
- The maxConcurrentStreams.
-
getMaxConcurrentStreamsOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxConcurrentStreamsOrBuilder()`Maximum concurrent streams <https://httpwg.org/specs/rfc7540.html#rfc.section.5.1.2>`_ allowed for peer on one HTTP/2 connection. Valid values range from 1 to 2147483647 (2^31 - 1) and defaults to 2147483647. For upstream connections, this also limits how many streams Envoy will initiate concurrently on a single connection. If the limit is reached, Envoy may queue requests or establish additional connections (as allowed per circuit breaker limits). This acts as an upper bound: Envoy will lower the max concurrent streams allowed on a given connection based on upstream settings. Config dumps will reflect the configured upper bound, not the per-connection negotiated limits.
.google.protobuf.UInt32Value max_concurrent_streams = 2 [(.validate.rules) = { ... }
-
hasInitialStreamWindowSize
boolean hasInitialStreamWindowSize()`Initial stream-level flow-control window <https://httpwg.org/specs/rfc7540.html#rfc.section.6.9.2>`_ size. Valid values range from 65535 (2^16 - 1, HTTP/2 default) to 2147483647 (2^31 - 1, HTTP/2 maximum) and defaults to 268435456 (256 * 1024 * 1024). NOTE: 65535 is the initial window size from HTTP/2 spec. We only support increasing the default window size now, so it's also the minimum. This field also acts as a soft limit on the number of bytes Envoy will buffer per-stream in the HTTP/2 codec buffers. Once the buffer reaches this pointer, watermark callbacks will fire to stop the flow of data to the codec buffers.
.google.protobuf.UInt32Value initial_stream_window_size = 3 [(.validate.rules) = { ... }
- Returns:
- Whether the initialStreamWindowSize field is set.
-
getInitialStreamWindowSize
com.google.protobuf.UInt32Value getInitialStreamWindowSize()`Initial stream-level flow-control window <https://httpwg.org/specs/rfc7540.html#rfc.section.6.9.2>`_ size. Valid values range from 65535 (2^16 - 1, HTTP/2 default) to 2147483647 (2^31 - 1, HTTP/2 maximum) and defaults to 268435456 (256 * 1024 * 1024). NOTE: 65535 is the initial window size from HTTP/2 spec. We only support increasing the default window size now, so it's also the minimum. This field also acts as a soft limit on the number of bytes Envoy will buffer per-stream in the HTTP/2 codec buffers. Once the buffer reaches this pointer, watermark callbacks will fire to stop the flow of data to the codec buffers.
.google.protobuf.UInt32Value initial_stream_window_size = 3 [(.validate.rules) = { ... }
- Returns:
- The initialStreamWindowSize.
-
getInitialStreamWindowSizeOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getInitialStreamWindowSizeOrBuilder()`Initial stream-level flow-control window <https://httpwg.org/specs/rfc7540.html#rfc.section.6.9.2>`_ size. Valid values range from 65535 (2^16 - 1, HTTP/2 default) to 2147483647 (2^31 - 1, HTTP/2 maximum) and defaults to 268435456 (256 * 1024 * 1024). NOTE: 65535 is the initial window size from HTTP/2 spec. We only support increasing the default window size now, so it's also the minimum. This field also acts as a soft limit on the number of bytes Envoy will buffer per-stream in the HTTP/2 codec buffers. Once the buffer reaches this pointer, watermark callbacks will fire to stop the flow of data to the codec buffers.
.google.protobuf.UInt32Value initial_stream_window_size = 3 [(.validate.rules) = { ... }
-
hasInitialConnectionWindowSize
boolean hasInitialConnectionWindowSize()Similar to ``initial_stream_window_size``, but for connection-level flow-control window. Currently, this has the same minimum/maximum/default as ``initial_stream_window_size``.
.google.protobuf.UInt32Value initial_connection_window_size = 4 [(.validate.rules) = { ... }
- Returns:
- Whether the initialConnectionWindowSize field is set.
-
getInitialConnectionWindowSize
com.google.protobuf.UInt32Value getInitialConnectionWindowSize()Similar to ``initial_stream_window_size``, but for connection-level flow-control window. Currently, this has the same minimum/maximum/default as ``initial_stream_window_size``.
.google.protobuf.UInt32Value initial_connection_window_size = 4 [(.validate.rules) = { ... }
- Returns:
- The initialConnectionWindowSize.
-
getInitialConnectionWindowSizeOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getInitialConnectionWindowSizeOrBuilder()Similar to ``initial_stream_window_size``, but for connection-level flow-control window. Currently, this has the same minimum/maximum/default as ``initial_stream_window_size``.
.google.protobuf.UInt32Value initial_connection_window_size = 4 [(.validate.rules) = { ... }
-
getAllowConnect
boolean getAllowConnect()Allows proxying Websocket and other upgrades over H2 connect.
bool allow_connect = 5;
- Returns:
- The allowConnect.
-
getAllowMetadata
boolean getAllowMetadata()[#not-implemented-hide:] Hiding until Envoy has full metadata support. Still under implementation. DO NOT USE. Allows sending and receiving HTTP/2 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.
-
hasMaxOutboundFrames
boolean hasMaxOutboundFrames()Limit the number of pending outbound downstream frames of all types (frames that are waiting to be written into the socket). Exceeding this limit triggers flood mitigation and connection is terminated. The ``http2.outbound_flood`` stat tracks the number of terminated connections due to flood mitigation. The default limit is 10000.
.google.protobuf.UInt32Value max_outbound_frames = 7 [(.validate.rules) = { ... }
- Returns:
- Whether the maxOutboundFrames field is set.
-
getMaxOutboundFrames
com.google.protobuf.UInt32Value getMaxOutboundFrames()Limit the number of pending outbound downstream frames of all types (frames that are waiting to be written into the socket). Exceeding this limit triggers flood mitigation and connection is terminated. The ``http2.outbound_flood`` stat tracks the number of terminated connections due to flood mitigation. The default limit is 10000.
.google.protobuf.UInt32Value max_outbound_frames = 7 [(.validate.rules) = { ... }
- Returns:
- The maxOutboundFrames.
-
getMaxOutboundFramesOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxOutboundFramesOrBuilder()Limit the number of pending outbound downstream frames of all types (frames that are waiting to be written into the socket). Exceeding this limit triggers flood mitigation and connection is terminated. The ``http2.outbound_flood`` stat tracks the number of terminated connections due to flood mitigation. The default limit is 10000.
.google.protobuf.UInt32Value max_outbound_frames = 7 [(.validate.rules) = { ... }
-
hasMaxOutboundControlFrames
boolean hasMaxOutboundControlFrames()Limit the number of pending outbound downstream frames of types PING, SETTINGS and RST_STREAM, preventing high memory utilization when receiving continuous stream of these frames. Exceeding this limit triggers flood mitigation and connection is terminated. The ``http2.outbound_control_flood`` stat tracks the number of terminated connections due to flood mitigation. The default limit is 1000.
.google.protobuf.UInt32Value max_outbound_control_frames = 8 [(.validate.rules) = { ... }
- Returns:
- Whether the maxOutboundControlFrames field is set.
-
getMaxOutboundControlFrames
com.google.protobuf.UInt32Value getMaxOutboundControlFrames()Limit the number of pending outbound downstream frames of types PING, SETTINGS and RST_STREAM, preventing high memory utilization when receiving continuous stream of these frames. Exceeding this limit triggers flood mitigation and connection is terminated. The ``http2.outbound_control_flood`` stat tracks the number of terminated connections due to flood mitigation. The default limit is 1000.
.google.protobuf.UInt32Value max_outbound_control_frames = 8 [(.validate.rules) = { ... }
- Returns:
- The maxOutboundControlFrames.
-
getMaxOutboundControlFramesOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxOutboundControlFramesOrBuilder()Limit the number of pending outbound downstream frames of types PING, SETTINGS and RST_STREAM, preventing high memory utilization when receiving continuous stream of these frames. Exceeding this limit triggers flood mitigation and connection is terminated. The ``http2.outbound_control_flood`` stat tracks the number of terminated connections due to flood mitigation. The default limit is 1000.
.google.protobuf.UInt32Value max_outbound_control_frames = 8 [(.validate.rules) = { ... }
-
hasMaxConsecutiveInboundFramesWithEmptyPayload
boolean hasMaxConsecutiveInboundFramesWithEmptyPayload()Limit the number of consecutive inbound frames of types HEADERS, CONTINUATION and DATA with an empty payload and no end stream flag. Those frames have no legitimate use and are abusive, but might be a result of a broken HTTP/2 implementation. The `http2.inbound_empty_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. Setting this to 0 will terminate connection upon receiving first frame with an empty payload and no end stream flag. The default limit is 1.
.google.protobuf.UInt32Value max_consecutive_inbound_frames_with_empty_payload = 9;
- Returns:
- Whether the maxConsecutiveInboundFramesWithEmptyPayload field is set.
-
getMaxConsecutiveInboundFramesWithEmptyPayload
com.google.protobuf.UInt32Value getMaxConsecutiveInboundFramesWithEmptyPayload()Limit the number of consecutive inbound frames of types HEADERS, CONTINUATION and DATA with an empty payload and no end stream flag. Those frames have no legitimate use and are abusive, but might be a result of a broken HTTP/2 implementation. The `http2.inbound_empty_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. Setting this to 0 will terminate connection upon receiving first frame with an empty payload and no end stream flag. The default limit is 1.
.google.protobuf.UInt32Value max_consecutive_inbound_frames_with_empty_payload = 9;
- Returns:
- The maxConsecutiveInboundFramesWithEmptyPayload.
-
getMaxConsecutiveInboundFramesWithEmptyPayloadOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxConsecutiveInboundFramesWithEmptyPayloadOrBuilder()Limit the number of consecutive inbound frames of types HEADERS, CONTINUATION and DATA with an empty payload and no end stream flag. Those frames have no legitimate use and are abusive, but might be a result of a broken HTTP/2 implementation. The `http2.inbound_empty_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. Setting this to 0 will terminate connection upon receiving first frame with an empty payload and no end stream flag. The default limit is 1.
.google.protobuf.UInt32Value max_consecutive_inbound_frames_with_empty_payload = 9;
-
hasMaxInboundPriorityFramesPerStream
boolean hasMaxInboundPriorityFramesPerStream()Limit the number of inbound PRIORITY frames allowed per each opened stream. If the number of PRIORITY frames received over the lifetime of connection exceeds the value calculated using this formula:: ``max_inbound_priority_frames_per_stream`` * (1 + ``opened_streams``) the connection is terminated. For downstream connections the ``opened_streams`` is incremented when Envoy receives complete response headers from the upstream server. For upstream connection the ``opened_streams`` is incremented when Envoy send the HEADERS frame for a new stream. The ``http2.inbound_priority_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. The default limit is 100.
.google.protobuf.UInt32Value max_inbound_priority_frames_per_stream = 10;
- Returns:
- Whether the maxInboundPriorityFramesPerStream field is set.
-
getMaxInboundPriorityFramesPerStream
com.google.protobuf.UInt32Value getMaxInboundPriorityFramesPerStream()Limit the number of inbound PRIORITY frames allowed per each opened stream. If the number of PRIORITY frames received over the lifetime of connection exceeds the value calculated using this formula:: ``max_inbound_priority_frames_per_stream`` * (1 + ``opened_streams``) the connection is terminated. For downstream connections the ``opened_streams`` is incremented when Envoy receives complete response headers from the upstream server. For upstream connection the ``opened_streams`` is incremented when Envoy send the HEADERS frame for a new stream. The ``http2.inbound_priority_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. The default limit is 100.
.google.protobuf.UInt32Value max_inbound_priority_frames_per_stream = 10;
- Returns:
- The maxInboundPriorityFramesPerStream.
-
getMaxInboundPriorityFramesPerStreamOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxInboundPriorityFramesPerStreamOrBuilder()Limit the number of inbound PRIORITY frames allowed per each opened stream. If the number of PRIORITY frames received over the lifetime of connection exceeds the value calculated using this formula:: ``max_inbound_priority_frames_per_stream`` * (1 + ``opened_streams``) the connection is terminated. For downstream connections the ``opened_streams`` is incremented when Envoy receives complete response headers from the upstream server. For upstream connection the ``opened_streams`` is incremented when Envoy send the HEADERS frame for a new stream. The ``http2.inbound_priority_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. The default limit is 100.
.google.protobuf.UInt32Value max_inbound_priority_frames_per_stream = 10;
-
hasMaxInboundWindowUpdateFramesPerDataFrameSent
boolean hasMaxInboundWindowUpdateFramesPerDataFrameSent()Limit the number of inbound WINDOW_UPDATE frames allowed per DATA frame sent. If the number of WINDOW_UPDATE frames received over the lifetime of connection exceeds the value calculated using this formula:: 5 + 2 * (``opened_streams`` + ``max_inbound_window_update_frames_per_data_frame_sent`` * ``outbound_data_frames``) the connection is terminated. For downstream connections the ``opened_streams`` is incremented when Envoy receives complete response headers from the upstream server. For upstream connections the ``opened_streams`` is incremented when Envoy sends the HEADERS frame for a new stream. The ``http2.inbound_priority_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. The default max_inbound_window_update_frames_per_data_frame_sent value is 10. Setting this to 1 should be enough to support HTTP/2 implementations with basic flow control, but more complex implementations that try to estimate available bandwidth require at least 2.
.google.protobuf.UInt32Value max_inbound_window_update_frames_per_data_frame_sent = 11 [(.validate.rules) = { ... }
- Returns:
- Whether the maxInboundWindowUpdateFramesPerDataFrameSent field is set.
-
getMaxInboundWindowUpdateFramesPerDataFrameSent
com.google.protobuf.UInt32Value getMaxInboundWindowUpdateFramesPerDataFrameSent()Limit the number of inbound WINDOW_UPDATE frames allowed per DATA frame sent. If the number of WINDOW_UPDATE frames received over the lifetime of connection exceeds the value calculated using this formula:: 5 + 2 * (``opened_streams`` + ``max_inbound_window_update_frames_per_data_frame_sent`` * ``outbound_data_frames``) the connection is terminated. For downstream connections the ``opened_streams`` is incremented when Envoy receives complete response headers from the upstream server. For upstream connections the ``opened_streams`` is incremented when Envoy sends the HEADERS frame for a new stream. The ``http2.inbound_priority_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. The default max_inbound_window_update_frames_per_data_frame_sent value is 10. Setting this to 1 should be enough to support HTTP/2 implementations with basic flow control, but more complex implementations that try to estimate available bandwidth require at least 2.
.google.protobuf.UInt32Value max_inbound_window_update_frames_per_data_frame_sent = 11 [(.validate.rules) = { ... }
- Returns:
- The maxInboundWindowUpdateFramesPerDataFrameSent.
-
getMaxInboundWindowUpdateFramesPerDataFrameSentOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getMaxInboundWindowUpdateFramesPerDataFrameSentOrBuilder()Limit the number of inbound WINDOW_UPDATE frames allowed per DATA frame sent. If the number of WINDOW_UPDATE frames received over the lifetime of connection exceeds the value calculated using this formula:: 5 + 2 * (``opened_streams`` + ``max_inbound_window_update_frames_per_data_frame_sent`` * ``outbound_data_frames``) the connection is terminated. For downstream connections the ``opened_streams`` is incremented when Envoy receives complete response headers from the upstream server. For upstream connections the ``opened_streams`` is incremented when Envoy sends the HEADERS frame for a new stream. The ``http2.inbound_priority_frames_flood`` stat tracks the number of connections terminated due to flood mitigation. The default max_inbound_window_update_frames_per_data_frame_sent value is 10. Setting this to 1 should be enough to support HTTP/2 implementations with basic flow control, but more complex implementations that try to estimate available bandwidth require at least 2.
.google.protobuf.UInt32Value max_inbound_window_update_frames_per_data_frame_sent = 11 [(.validate.rules) = { ... }
-
getStreamErrorOnInvalidHttpMessaging
Deprecated.envoy.config.core.v3.Http2ProtocolOptions.stream_error_on_invalid_http_messaging is deprecated. See envoy/config/core/v3/protocol.proto;l=559Allows invalid HTTP messaging and headers. When this option is disabled (default), then the whole HTTP/2 connection is terminated upon receiving invalid HEADERS frame. However, when this option is enabled, only the offending stream is terminated. This is overridden by 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>` iff present. This is deprecated in favor of :ref:`override_stream_error_on_invalid_http_message <envoy_v3_api_field_config.core.v3.Http2ProtocolOptions.override_stream_error_on_invalid_http_message>` See `RFC7540, sec. 8.1 <https://tools.ietf.org/html/rfc7540#section-8.1>`_ for details.
bool stream_error_on_invalid_http_messaging = 12 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Returns:
- The streamErrorOnInvalidHttpMessaging.
-
hasOverrideStreamErrorOnInvalidHttpMessage
boolean hasOverrideStreamErrorOnInvalidHttpMessage()Allows invalid HTTP messaging and headers. When this option is disabled (default), then the whole HTTP/2 connection is terminated upon receiving invalid HEADERS frame. However, when this option is enabled, only the offending stream is terminated. 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>` See `RFC7540, sec. 8.1 <https://tools.ietf.org/html/rfc7540#section-8.1>`_ for details.
.google.protobuf.BoolValue override_stream_error_on_invalid_http_message = 14;
- 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/2 connection is terminated upon receiving invalid HEADERS frame. However, when this option is enabled, only the offending stream is terminated. 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>` See `RFC7540, sec. 8.1 <https://tools.ietf.org/html/rfc7540#section-8.1>`_ for details.
.google.protobuf.BoolValue override_stream_error_on_invalid_http_message = 14;
- 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/2 connection is terminated upon receiving invalid HEADERS frame. However, when this option is enabled, only the offending stream is terminated. 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>` See `RFC7540, sec. 8.1 <https://tools.ietf.org/html/rfc7540#section-8.1>`_ for details.
.google.protobuf.BoolValue override_stream_error_on_invalid_http_message = 14;
-
getCustomSettingsParametersList
List<Http2ProtocolOptions.SettingsParameter> getCustomSettingsParametersList()[#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1. SETTINGS_ENABLE_PUSH (0x2) is not configurable as HTTP/2 server push is not supported by Envoy. 2. SETTINGS_ENABLE_CONNECT_PROTOCOL (0x8) is only configurable through the named field 'allow_connect'. Note that custom parameters specified through this field can not also be set in the corresponding named parameters: .. code-block:: text ID Field Name ---------------- 0x1 hpack_table_size 0x3 max_concurrent_streams 0x4 initial_stream_window_size Collisions will trigger config validation failure on load/update. Likewise, inconsistencies between custom parameters with the same identifier will trigger a failure. See `IANA HTTP/2 Settings <https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#settings>`_ for standardized identifiers.
repeated .envoy.config.core.v3.Http2ProtocolOptions.SettingsParameter custom_settings_parameters = 13;
-
getCustomSettingsParameters
[#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1. SETTINGS_ENABLE_PUSH (0x2) is not configurable as HTTP/2 server push is not supported by Envoy. 2. SETTINGS_ENABLE_CONNECT_PROTOCOL (0x8) is only configurable through the named field 'allow_connect'. Note that custom parameters specified through this field can not also be set in the corresponding named parameters: .. code-block:: text ID Field Name ---------------- 0x1 hpack_table_size 0x3 max_concurrent_streams 0x4 initial_stream_window_size Collisions will trigger config validation failure on load/update. Likewise, inconsistencies between custom parameters with the same identifier will trigger a failure. See `IANA HTTP/2 Settings <https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#settings>`_ for standardized identifiers.
repeated .envoy.config.core.v3.Http2ProtocolOptions.SettingsParameter custom_settings_parameters = 13;
-
getCustomSettingsParametersCount
int getCustomSettingsParametersCount()[#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1. SETTINGS_ENABLE_PUSH (0x2) is not configurable as HTTP/2 server push is not supported by Envoy. 2. SETTINGS_ENABLE_CONNECT_PROTOCOL (0x8) is only configurable through the named field 'allow_connect'. Note that custom parameters specified through this field can not also be set in the corresponding named parameters: .. code-block:: text ID Field Name ---------------- 0x1 hpack_table_size 0x3 max_concurrent_streams 0x4 initial_stream_window_size Collisions will trigger config validation failure on load/update. Likewise, inconsistencies between custom parameters with the same identifier will trigger a failure. See `IANA HTTP/2 Settings <https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#settings>`_ for standardized identifiers.
repeated .envoy.config.core.v3.Http2ProtocolOptions.SettingsParameter custom_settings_parameters = 13;
-
getCustomSettingsParametersOrBuilderList
List<? extends Http2ProtocolOptions.SettingsParameterOrBuilder> getCustomSettingsParametersOrBuilderList()[#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1. SETTINGS_ENABLE_PUSH (0x2) is not configurable as HTTP/2 server push is not supported by Envoy. 2. SETTINGS_ENABLE_CONNECT_PROTOCOL (0x8) is only configurable through the named field 'allow_connect'. Note that custom parameters specified through this field can not also be set in the corresponding named parameters: .. code-block:: text ID Field Name ---------------- 0x1 hpack_table_size 0x3 max_concurrent_streams 0x4 initial_stream_window_size Collisions will trigger config validation failure on load/update. Likewise, inconsistencies between custom parameters with the same identifier will trigger a failure. See `IANA HTTP/2 Settings <https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#settings>`_ for standardized identifiers.
repeated .envoy.config.core.v3.Http2ProtocolOptions.SettingsParameter custom_settings_parameters = 13;
-
getCustomSettingsParametersOrBuilder
[#not-implemented-hide:] Specifies SETTINGS frame parameters to be sent to the peer, with two exceptions: 1. SETTINGS_ENABLE_PUSH (0x2) is not configurable as HTTP/2 server push is not supported by Envoy. 2. SETTINGS_ENABLE_CONNECT_PROTOCOL (0x8) is only configurable through the named field 'allow_connect'. Note that custom parameters specified through this field can not also be set in the corresponding named parameters: .. code-block:: text ID Field Name ---------------- 0x1 hpack_table_size 0x3 max_concurrent_streams 0x4 initial_stream_window_size Collisions will trigger config validation failure on load/update. Likewise, inconsistencies between custom parameters with the same identifier will trigger a failure. See `IANA HTTP/2 Settings <https://www.iana.org/assignments/http2-parameters/http2-parameters.xhtml#settings>`_ for standardized identifiers.
repeated .envoy.config.core.v3.Http2ProtocolOptions.SettingsParameter custom_settings_parameters = 13;
-
hasConnectionKeepalive
boolean hasConnectionKeepalive()Send HTTP/2 PING frames to verify that the connection is still healthy. If the remote peer does not respond within the configured timeout, the connection will be aborted.
.envoy.config.core.v3.KeepaliveSettings connection_keepalive = 15;
- Returns:
- Whether the connectionKeepalive field is set.
-
getConnectionKeepalive
KeepaliveSettings getConnectionKeepalive()Send HTTP/2 PING frames to verify that the connection is still healthy. If the remote peer does not respond within the configured timeout, the connection will be aborted.
.envoy.config.core.v3.KeepaliveSettings connection_keepalive = 15;
- Returns:
- The connectionKeepalive.
-
getConnectionKeepaliveOrBuilder
KeepaliveSettingsOrBuilder getConnectionKeepaliveOrBuilder()Send HTTP/2 PING frames to verify that the connection is still healthy. If the remote peer does not respond within the configured timeout, the connection will be aborted.
.envoy.config.core.v3.KeepaliveSettings connection_keepalive = 15;
-
hasUseOghttp2Codec
boolean hasUseOghttp2Codec()[#not-implemented-hide:] Hiding so that the field can be removed after oghttp2 is rolled out. If set, force use of a particular HTTP/2 codec: oghttp2 if true, nghttp2 if false. If unset, HTTP/2 codec is selected based on envoy.reloadable_features.http2_use_oghttp2.
.google.protobuf.BoolValue use_oghttp2_codec = 16 [(.xds.annotations.v3.field_status) = { ... }
- Returns:
- Whether the useOghttp2Codec field is set.
-
getUseOghttp2Codec
com.google.protobuf.BoolValue getUseOghttp2Codec()[#not-implemented-hide:] Hiding so that the field can be removed after oghttp2 is rolled out. If set, force use of a particular HTTP/2 codec: oghttp2 if true, nghttp2 if false. If unset, HTTP/2 codec is selected based on envoy.reloadable_features.http2_use_oghttp2.
.google.protobuf.BoolValue use_oghttp2_codec = 16 [(.xds.annotations.v3.field_status) = { ... }
- Returns:
- The useOghttp2Codec.
-
getUseOghttp2CodecOrBuilder
com.google.protobuf.BoolValueOrBuilder getUseOghttp2CodecOrBuilder()[#not-implemented-hide:] Hiding so that the field can be removed after oghttp2 is rolled out. If set, force use of a particular HTTP/2 codec: oghttp2 if true, nghttp2 if false. If unset, HTTP/2 codec is selected based on envoy.reloadable_features.http2_use_oghttp2.
.google.protobuf.BoolValue use_oghttp2_codec = 16 [(.xds.annotations.v3.field_status) = { ... }
-