Interface QuicKeepAliveSettingsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
QuicKeepAliveSettings, QuicKeepAliveSettings.Builder

public interface QuicKeepAliveSettingsOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    The interval to send the first few keep-alive probing packets to prevent connection from hitting the idle timeout.
    com.google.protobuf.DurationOrBuilder
    The interval to send the first few keep-alive probing packets to prevent connection from hitting the idle timeout.
    com.google.protobuf.Duration
    The max interval for a connection to send keep-alive probing packets (with PING or PATH_RESPONSE).
    com.google.protobuf.DurationOrBuilder
    The max interval for a connection to send keep-alive probing packets (with PING or PATH_RESPONSE).
    boolean
    The interval to send the first few keep-alive probing packets to prevent connection from hitting the idle timeout.
    boolean
    The max interval for a connection to send keep-alive probing packets (with PING or PATH_RESPONSE).

    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

    • hasMaxInterval

      boolean hasMaxInterval()
       The max interval for a connection to send keep-alive probing packets (with PING or PATH_RESPONSE). The value should be smaller than :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` to prevent idle timeout while not less than 1s to avoid throttling the connection or flooding the peer with probes.
      
       If :ref:`initial_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.initial_interval>` is absent or zero, a client connection will use this value to start probing.
      
       If zero, disable keepalive probing.
       If absent, use the QUICHE default interval to probe.
       
      .google.protobuf.Duration max_interval = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the maxInterval field is set.
    • getMaxInterval

      com.google.protobuf.Duration getMaxInterval()
       The max interval for a connection to send keep-alive probing packets (with PING or PATH_RESPONSE). The value should be smaller than :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` to prevent idle timeout while not less than 1s to avoid throttling the connection or flooding the peer with probes.
      
       If :ref:`initial_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.initial_interval>` is absent or zero, a client connection will use this value to start probing.
      
       If zero, disable keepalive probing.
       If absent, use the QUICHE default interval to probe.
       
      .google.protobuf.Duration max_interval = 1 [(.validate.rules) = { ... }
      Returns:
      The maxInterval.
    • getMaxIntervalOrBuilder

      com.google.protobuf.DurationOrBuilder getMaxIntervalOrBuilder()
       The max interval for a connection to send keep-alive probing packets (with PING or PATH_RESPONSE). The value should be smaller than :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` to prevent idle timeout while not less than 1s to avoid throttling the connection or flooding the peer with probes.
      
       If :ref:`initial_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.initial_interval>` is absent or zero, a client connection will use this value to start probing.
      
       If zero, disable keepalive probing.
       If absent, use the QUICHE default interval to probe.
       
      .google.protobuf.Duration max_interval = 1 [(.validate.rules) = { ... }
    • hasInitialInterval

      boolean hasInitialInterval()
       The interval to send the first few keep-alive probing packets to prevent connection from hitting the idle timeout. Subsequent probes will be sent, each one with an interval exponentially longer than previous one, till it reaches :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`. And the probes afterwards will always use :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`.
      
       The value should be smaller than :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` to prevent idle timeout and smaller than max_interval to take effect.
      
       If absent or zero, disable keepalive probing for a server connection. For a client connection, if :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`  is also zero, do not keepalive, otherwise use max_interval or QUICHE default to probe all the time.
       
      .google.protobuf.Duration initial_interval = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the initialInterval field is set.
    • getInitialInterval

      com.google.protobuf.Duration getInitialInterval()
       The interval to send the first few keep-alive probing packets to prevent connection from hitting the idle timeout. Subsequent probes will be sent, each one with an interval exponentially longer than previous one, till it reaches :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`. And the probes afterwards will always use :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`.
      
       The value should be smaller than :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` to prevent idle timeout and smaller than max_interval to take effect.
      
       If absent or zero, disable keepalive probing for a server connection. For a client connection, if :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`  is also zero, do not keepalive, otherwise use max_interval or QUICHE default to probe all the time.
       
      .google.protobuf.Duration initial_interval = 2 [(.validate.rules) = { ... }
      Returns:
      The initialInterval.
    • getInitialIntervalOrBuilder

      com.google.protobuf.DurationOrBuilder getInitialIntervalOrBuilder()
       The interval to send the first few keep-alive probing packets to prevent connection from hitting the idle timeout. Subsequent probes will be sent, each one with an interval exponentially longer than previous one, till it reaches :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`. And the probes afterwards will always use :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`.
      
       The value should be smaller than :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` to prevent idle timeout and smaller than max_interval to take effect.
      
       If absent or zero, disable keepalive probing for a server connection. For a client connection, if :ref:`max_interval <envoy_v3_api_field_config.core.v3.QuicKeepAliveSettings.max_interval>`  is also zero, do not keepalive, otherwise use max_interval or QUICHE default to probe all the time.
       
      .google.protobuf.Duration initial_interval = 2 [(.validate.rules) = { ... }