Interface QuicProtocolOptionsOrBuilder
-
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
QuicProtocolOptions
,QuicProtocolOptions.Builder
public interface QuicProtocolOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description TypedExtensionConfig
getConnectionDebugVisitorConfig()
Configure which implementation of ``quic::QuicConnectionDebugVisitor`` to be used for this listener.TypedExtensionConfigOrBuilder
getConnectionDebugVisitorConfigOrBuilder()
Configure which implementation of ``quic::QuicConnectionDebugVisitor`` to be used for this listener.TypedExtensionConfig
getConnectionIdGeneratorConfig()
Config which implementation of ``quic::ConnectionIdGeneratorInterface`` to be used for this listener.TypedExtensionConfigOrBuilder
getConnectionIdGeneratorConfigOrBuilder()
Config which implementation of ``quic::ConnectionIdGeneratorInterface`` to be used for this listener.com.google.protobuf.Duration
getCryptoHandshakeTimeout()
Connection timeout in milliseconds before the crypto handshake is finished.com.google.protobuf.DurationOrBuilder
getCryptoHandshakeTimeoutOrBuilder()
Connection timeout in milliseconds before the crypto handshake is finished.TypedExtensionConfig
getCryptoStreamConfig()
Configure which implementation of ``quic::QuicCryptoClientStreamBase`` to be used for this listener.TypedExtensionConfigOrBuilder
getCryptoStreamConfigOrBuilder()
Configure which implementation of ``quic::QuicCryptoClientStreamBase`` to be used for this listener.RuntimeFeatureFlag
getEnabled()
Runtime flag that controls whether the listener is enabled or not.RuntimeFeatureFlagOrBuilder
getEnabledOrBuilder()
Runtime flag that controls whether the listener is enabled or not.com.google.protobuf.Duration
getIdleTimeout()
Maximum number of milliseconds that connection will be alive when there is no network activity.com.google.protobuf.DurationOrBuilder
getIdleTimeoutOrBuilder()
Maximum number of milliseconds that connection will be alive when there is no network activity.com.google.protobuf.UInt32Value
getPacketsToReadToConnectionCountRatio()
A multiplier to number of connections which is used to determine how many packets to read per event loop.com.google.protobuf.UInt32ValueOrBuilder
getPacketsToReadToConnectionCountRatioOrBuilder()
A multiplier to number of connections which is used to determine how many packets to read per event loop.TypedExtensionConfig
getProofSourceConfig()
Configure which implementation of ``quic::ProofSource`` to be used for this listener.TypedExtensionConfigOrBuilder
getProofSourceConfigOrBuilder()
Configure which implementation of ``quic::ProofSource`` to be used for this listener.QuicProtocolOptions
getQuicProtocolOptions()
.envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;
QuicProtocolOptionsOrBuilder
getQuicProtocolOptionsOrBuilder()
.envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;
com.google.protobuf.BoolValue
getSendDisableActiveMigration()
Configure the server to send transport parameter `disable_active_migration <https://www.rfc-editor.org/rfc/rfc9000#section-18.2-4.30.1>`_.com.google.protobuf.BoolValueOrBuilder
getSendDisableActiveMigrationOrBuilder()
Configure the server to send transport parameter `disable_active_migration <https://www.rfc-editor.org/rfc/rfc9000#section-18.2-4.30.1>`_.TypedExtensionConfig
getServerPreferredAddressConfig()
Configure the server's preferred address to advertise so that client can migrate to it.TypedExtensionConfigOrBuilder
getServerPreferredAddressConfigOrBuilder()
Configure the server's preferred address to advertise so that client can migrate to it.boolean
hasConnectionDebugVisitorConfig()
Configure which implementation of ``quic::QuicConnectionDebugVisitor`` to be used for this listener.boolean
hasConnectionIdGeneratorConfig()
Config which implementation of ``quic::ConnectionIdGeneratorInterface`` to be used for this listener.boolean
hasCryptoHandshakeTimeout()
Connection timeout in milliseconds before the crypto handshake is finished.boolean
hasCryptoStreamConfig()
Configure which implementation of ``quic::QuicCryptoClientStreamBase`` to be used for this listener.boolean
hasEnabled()
Runtime flag that controls whether the listener is enabled or not.boolean
hasIdleTimeout()
Maximum number of milliseconds that connection will be alive when there is no network activity.boolean
hasPacketsToReadToConnectionCountRatio()
A multiplier to number of connections which is used to determine how many packets to read per event loop.boolean
hasProofSourceConfig()
Configure which implementation of ``quic::ProofSource`` to be used for this listener.boolean
hasQuicProtocolOptions()
.envoy.config.core.v3.QuicProtocolOptions quic_protocol_options = 1;
boolean
hasSendDisableActiveMigration()
Configure the server to send transport parameter `disable_active_migration <https://www.rfc-editor.org/rfc/rfc9000#section-18.2-4.30.1>`_.boolean
hasServerPreferredAddressConfig()
Configure the server's preferred address to advertise so that client can migrate to it.-
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
-
-
-
Method Detail
-
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;
-
hasIdleTimeout
boolean hasIdleTimeout()
Maximum number of milliseconds that connection will be alive when there is no network activity. If it is less than 1ms, Envoy will use 1ms. 300000ms if not specified.
.google.protobuf.Duration idle_timeout = 2;
- Returns:
- Whether the idleTimeout field is set.
-
getIdleTimeout
com.google.protobuf.Duration getIdleTimeout()
Maximum number of milliseconds that connection will be alive when there is no network activity. If it is less than 1ms, Envoy will use 1ms. 300000ms if not specified.
.google.protobuf.Duration idle_timeout = 2;
- Returns:
- The idleTimeout.
-
getIdleTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()
Maximum number of milliseconds that connection will be alive when there is no network activity. If it is less than 1ms, Envoy will use 1ms. 300000ms if not specified.
.google.protobuf.Duration idle_timeout = 2;
-
hasCryptoHandshakeTimeout
boolean hasCryptoHandshakeTimeout()
Connection timeout in milliseconds before the crypto handshake is finished. If it is less than 5000ms, Envoy will use 5000ms. 20000ms if not specified.
.google.protobuf.Duration crypto_handshake_timeout = 3;
- Returns:
- Whether the cryptoHandshakeTimeout field is set.
-
getCryptoHandshakeTimeout
com.google.protobuf.Duration getCryptoHandshakeTimeout()
Connection timeout in milliseconds before the crypto handshake is finished. If it is less than 5000ms, Envoy will use 5000ms. 20000ms if not specified.
.google.protobuf.Duration crypto_handshake_timeout = 3;
- Returns:
- The cryptoHandshakeTimeout.
-
getCryptoHandshakeTimeoutOrBuilder
com.google.protobuf.DurationOrBuilder getCryptoHandshakeTimeoutOrBuilder()
Connection timeout in milliseconds before the crypto handshake is finished. If it is less than 5000ms, Envoy will use 5000ms. 20000ms if not specified.
.google.protobuf.Duration crypto_handshake_timeout = 3;
-
hasEnabled
boolean hasEnabled()
Runtime flag that controls whether the listener is enabled or not. If not specified, defaults to enabled.
.envoy.config.core.v3.RuntimeFeatureFlag enabled = 4;
- Returns:
- Whether the enabled field is set.
-
getEnabled
RuntimeFeatureFlag getEnabled()
Runtime flag that controls whether the listener is enabled or not. If not specified, defaults to enabled.
.envoy.config.core.v3.RuntimeFeatureFlag enabled = 4;
- Returns:
- The enabled.
-
getEnabledOrBuilder
RuntimeFeatureFlagOrBuilder getEnabledOrBuilder()
Runtime flag that controls whether the listener is enabled or not. If not specified, defaults to enabled.
.envoy.config.core.v3.RuntimeFeatureFlag enabled = 4;
-
hasPacketsToReadToConnectionCountRatio
boolean hasPacketsToReadToConnectionCountRatio()
A multiplier to number of connections which is used to determine how many packets to read per event loop. A reasonable number should allow the listener to process enough payload but not starve TCP and other UDP sockets and also prevent long event loop duration. The default value is 32. This means if there are N QUIC connections, the total number of packets to read in each read event will be 32 * N. The actual number of packets to read in total by the UDP listener is also bound by 6000, regardless of this field or how many connections there are.
.google.protobuf.UInt32Value packets_to_read_to_connection_count_ratio = 5 [(.validate.rules) = { ... }
- Returns:
- Whether the packetsToReadToConnectionCountRatio field is set.
-
getPacketsToReadToConnectionCountRatio
com.google.protobuf.UInt32Value getPacketsToReadToConnectionCountRatio()
A multiplier to number of connections which is used to determine how many packets to read per event loop. A reasonable number should allow the listener to process enough payload but not starve TCP and other UDP sockets and also prevent long event loop duration. The default value is 32. This means if there are N QUIC connections, the total number of packets to read in each read event will be 32 * N. The actual number of packets to read in total by the UDP listener is also bound by 6000, regardless of this field or how many connections there are.
.google.protobuf.UInt32Value packets_to_read_to_connection_count_ratio = 5 [(.validate.rules) = { ... }
- Returns:
- The packetsToReadToConnectionCountRatio.
-
getPacketsToReadToConnectionCountRatioOrBuilder
com.google.protobuf.UInt32ValueOrBuilder getPacketsToReadToConnectionCountRatioOrBuilder()
A multiplier to number of connections which is used to determine how many packets to read per event loop. A reasonable number should allow the listener to process enough payload but not starve TCP and other UDP sockets and also prevent long event loop duration. The default value is 32. This means if there are N QUIC connections, the total number of packets to read in each read event will be 32 * N. The actual number of packets to read in total by the UDP listener is also bound by 6000, regardless of this field or how many connections there are.
.google.protobuf.UInt32Value packets_to_read_to_connection_count_ratio = 5 [(.validate.rules) = { ... }
-
hasCryptoStreamConfig
boolean hasCryptoStreamConfig()
Configure which implementation of ``quic::QuicCryptoClientStreamBase`` to be used for this listener. If not specified the :ref:`QUICHE default one configured by <envoy_v3_api_msg_extensions.quic.crypto_stream.v3.CryptoServerStreamConfig>` will be used. [#extension-category: envoy.quic.server.crypto_stream]
.envoy.config.core.v3.TypedExtensionConfig crypto_stream_config = 6;
- Returns:
- Whether the cryptoStreamConfig field is set.
-
getCryptoStreamConfig
TypedExtensionConfig getCryptoStreamConfig()
Configure which implementation of ``quic::QuicCryptoClientStreamBase`` to be used for this listener. If not specified the :ref:`QUICHE default one configured by <envoy_v3_api_msg_extensions.quic.crypto_stream.v3.CryptoServerStreamConfig>` will be used. [#extension-category: envoy.quic.server.crypto_stream]
.envoy.config.core.v3.TypedExtensionConfig crypto_stream_config = 6;
- Returns:
- The cryptoStreamConfig.
-
getCryptoStreamConfigOrBuilder
TypedExtensionConfigOrBuilder getCryptoStreamConfigOrBuilder()
Configure which implementation of ``quic::QuicCryptoClientStreamBase`` to be used for this listener. If not specified the :ref:`QUICHE default one configured by <envoy_v3_api_msg_extensions.quic.crypto_stream.v3.CryptoServerStreamConfig>` will be used. [#extension-category: envoy.quic.server.crypto_stream]
.envoy.config.core.v3.TypedExtensionConfig crypto_stream_config = 6;
-
hasProofSourceConfig
boolean hasProofSourceConfig()
Configure which implementation of ``quic::ProofSource`` to be used for this listener. If not specified the :ref:`default one configured by <envoy_v3_api_msg_extensions.quic.proof_source.v3.ProofSourceConfig>` will be used. [#extension-category: envoy.quic.proof_source]
.envoy.config.core.v3.TypedExtensionConfig proof_source_config = 7;
- Returns:
- Whether the proofSourceConfig field is set.
-
getProofSourceConfig
TypedExtensionConfig getProofSourceConfig()
Configure which implementation of ``quic::ProofSource`` to be used for this listener. If not specified the :ref:`default one configured by <envoy_v3_api_msg_extensions.quic.proof_source.v3.ProofSourceConfig>` will be used. [#extension-category: envoy.quic.proof_source]
.envoy.config.core.v3.TypedExtensionConfig proof_source_config = 7;
- Returns:
- The proofSourceConfig.
-
getProofSourceConfigOrBuilder
TypedExtensionConfigOrBuilder getProofSourceConfigOrBuilder()
Configure which implementation of ``quic::ProofSource`` to be used for this listener. If not specified the :ref:`default one configured by <envoy_v3_api_msg_extensions.quic.proof_source.v3.ProofSourceConfig>` will be used. [#extension-category: envoy.quic.proof_source]
.envoy.config.core.v3.TypedExtensionConfig proof_source_config = 7;
-
hasConnectionIdGeneratorConfig
boolean hasConnectionIdGeneratorConfig()
Config which implementation of ``quic::ConnectionIdGeneratorInterface`` to be used for this listener. If not specified the :ref:`default one configured by <envoy_v3_api_msg_extensions.quic.connection_id_generator.v3.DeterministicConnectionIdGeneratorConfig>` will be used. [#extension-category: envoy.quic.connection_id_generator]
.envoy.config.core.v3.TypedExtensionConfig connection_id_generator_config = 8;
- Returns:
- Whether the connectionIdGeneratorConfig field is set.
-
getConnectionIdGeneratorConfig
TypedExtensionConfig getConnectionIdGeneratorConfig()
Config which implementation of ``quic::ConnectionIdGeneratorInterface`` to be used for this listener. If not specified the :ref:`default one configured by <envoy_v3_api_msg_extensions.quic.connection_id_generator.v3.DeterministicConnectionIdGeneratorConfig>` will be used. [#extension-category: envoy.quic.connection_id_generator]
.envoy.config.core.v3.TypedExtensionConfig connection_id_generator_config = 8;
- Returns:
- The connectionIdGeneratorConfig.
-
getConnectionIdGeneratorConfigOrBuilder
TypedExtensionConfigOrBuilder getConnectionIdGeneratorConfigOrBuilder()
Config which implementation of ``quic::ConnectionIdGeneratorInterface`` to be used for this listener. If not specified the :ref:`default one configured by <envoy_v3_api_msg_extensions.quic.connection_id_generator.v3.DeterministicConnectionIdGeneratorConfig>` will be used. [#extension-category: envoy.quic.connection_id_generator]
.envoy.config.core.v3.TypedExtensionConfig connection_id_generator_config = 8;
-
hasServerPreferredAddressConfig
boolean hasServerPreferredAddressConfig()
Configure the server's preferred address to advertise so that client can migrate to it. See :ref:`example <envoy_v3_api_msg_extensions.quic.server_preferred_address.v3.FixedServerPreferredAddressConfig>` which configures a pair of v4 and v6 preferred addresses. The current QUICHE implementation will advertise only one of the preferred IPv4 and IPv6 addresses based on the address family the client initially connects with. If not specified, Envoy will not advertise any server's preferred address. [#extension-category: envoy.quic.server_preferred_address]
.envoy.config.core.v3.TypedExtensionConfig server_preferred_address_config = 9 [(.xds.annotations.v3.field_status) = { ... }
- Returns:
- Whether the serverPreferredAddressConfig field is set.
-
getServerPreferredAddressConfig
TypedExtensionConfig getServerPreferredAddressConfig()
Configure the server's preferred address to advertise so that client can migrate to it. See :ref:`example <envoy_v3_api_msg_extensions.quic.server_preferred_address.v3.FixedServerPreferredAddressConfig>` which configures a pair of v4 and v6 preferred addresses. The current QUICHE implementation will advertise only one of the preferred IPv4 and IPv6 addresses based on the address family the client initially connects with. If not specified, Envoy will not advertise any server's preferred address. [#extension-category: envoy.quic.server_preferred_address]
.envoy.config.core.v3.TypedExtensionConfig server_preferred_address_config = 9 [(.xds.annotations.v3.field_status) = { ... }
- Returns:
- The serverPreferredAddressConfig.
-
getServerPreferredAddressConfigOrBuilder
TypedExtensionConfigOrBuilder getServerPreferredAddressConfigOrBuilder()
Configure the server's preferred address to advertise so that client can migrate to it. See :ref:`example <envoy_v3_api_msg_extensions.quic.server_preferred_address.v3.FixedServerPreferredAddressConfig>` which configures a pair of v4 and v6 preferred addresses. The current QUICHE implementation will advertise only one of the preferred IPv4 and IPv6 addresses based on the address family the client initially connects with. If not specified, Envoy will not advertise any server's preferred address. [#extension-category: envoy.quic.server_preferred_address]
.envoy.config.core.v3.TypedExtensionConfig server_preferred_address_config = 9 [(.xds.annotations.v3.field_status) = { ... }
-
hasSendDisableActiveMigration
boolean hasSendDisableActiveMigration()
Configure the server to send transport parameter `disable_active_migration <https://www.rfc-editor.org/rfc/rfc9000#section-18.2-4.30.1>`_. Defaults to false (do not send this transport parameter).
.google.protobuf.BoolValue send_disable_active_migration = 10;
- Returns:
- Whether the sendDisableActiveMigration field is set.
-
getSendDisableActiveMigration
com.google.protobuf.BoolValue getSendDisableActiveMigration()
Configure the server to send transport parameter `disable_active_migration <https://www.rfc-editor.org/rfc/rfc9000#section-18.2-4.30.1>`_. Defaults to false (do not send this transport parameter).
.google.protobuf.BoolValue send_disable_active_migration = 10;
- Returns:
- The sendDisableActiveMigration.
-
getSendDisableActiveMigrationOrBuilder
com.google.protobuf.BoolValueOrBuilder getSendDisableActiveMigrationOrBuilder()
Configure the server to send transport parameter `disable_active_migration <https://www.rfc-editor.org/rfc/rfc9000#section-18.2-4.30.1>`_. Defaults to false (do not send this transport parameter).
.google.protobuf.BoolValue send_disable_active_migration = 10;
-
hasConnectionDebugVisitorConfig
boolean hasConnectionDebugVisitorConfig()
Configure which implementation of ``quic::QuicConnectionDebugVisitor`` to be used for this listener. If not specified, no debug visitor will be attached to connections. [#extension-category: envoy.quic.connection_debug_visitor]
.envoy.config.core.v3.TypedExtensionConfig connection_debug_visitor_config = 11;
- Returns:
- Whether the connectionDebugVisitorConfig field is set.
-
getConnectionDebugVisitorConfig
TypedExtensionConfig getConnectionDebugVisitorConfig()
Configure which implementation of ``quic::QuicConnectionDebugVisitor`` to be used for this listener. If not specified, no debug visitor will be attached to connections. [#extension-category: envoy.quic.connection_debug_visitor]
.envoy.config.core.v3.TypedExtensionConfig connection_debug_visitor_config = 11;
- Returns:
- The connectionDebugVisitorConfig.
-
getConnectionDebugVisitorConfigOrBuilder
TypedExtensionConfigOrBuilder getConnectionDebugVisitorConfigOrBuilder()
Configure which implementation of ``quic::QuicConnectionDebugVisitor`` to be used for this listener. If not specified, no debug visitor will be attached to connections. [#extension-category: envoy.quic.connection_debug_visitor]
.envoy.config.core.v3.TypedExtensionConfig connection_debug_visitor_config = 11;
-
-