Interface KeepaliveSettingsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
KeepaliveSettings, KeepaliveSettings.Builder
@Generated public interface KeepaliveSettingsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getConnectionIdleInterval()
    If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections.
    com.google.protobuf.DurationOrBuilder
    getConnectionIdleIntervalOrBuilder()
    If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections.
    com.google.protobuf.Duration
    getInterval()
    Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.
    Percent
    getIntervalJitter()
    A random jitter amount as a percentage of interval that will be added to each interval.
    PercentOrBuilder
    getIntervalJitterOrBuilder()
    A random jitter amount as a percentage of interval that will be added to each interval.
    com.google.protobuf.DurationOrBuilder
    getIntervalOrBuilder()
    Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.
    com.google.protobuf.Duration
    getTimeout()
    How long to wait for a response to a keepalive PING.
    com.google.protobuf.DurationOrBuilder
    getTimeoutOrBuilder()
    How long to wait for a response to a keepalive PING.
    boolean
    hasConnectionIdleInterval()
    If the connection has been idle for this duration, send a HTTP/2 ping ahead of new stream creation, to quickly detect dead connections.
    boolean
    hasInterval()
    Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.
    boolean
    hasIntervalJitter()
    A random jitter amount as a percentage of interval that will be added to each interval.
    boolean
    hasTimeout()
    How long to wait for a response to a keepalive PING.

    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

    • hasInterval

      boolean hasInterval()
      Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.
If this is zero, interval PINGs will not be sent.
      .google.protobuf.Duration interval = 1 [(.validate.rules) = { ... }
      Returns:
      Whether the interval field is set.

    • getInterval

      com.google.protobuf.Duration getInterval()
      Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.
If this is zero, interval PINGs will not be sent.
      .google.protobuf.Duration interval = 1 [(.validate.rules) = { ... }
      Returns:
      The interval.

    • getIntervalOrBuilder

      com.google.protobuf.DurationOrBuilder getIntervalOrBuilder()
      Send HTTP/2 PING frames at this period, in order to test that the connection is still alive.
If this is zero, interval PINGs will not be sent.
      .google.protobuf.Duration interval = 1 [(.validate.rules) = { ... }

    • hasTimeout

      boolean hasTimeout()
      How long to wait for a response to a keepalive PING. If a response is not received within this
time period, the connection will be aborted. Note that in order to prevent the influence of
Head-of-line (HOL) blocking the timeout period is extended when *any* frame is received on
the connection, under the assumption that if a frame is received the connection is healthy.
      .google.protobuf.Duration timeout = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the timeout field is set.

    • getTimeout

      com.google.protobuf.Duration getTimeout()
      How long to wait for a response to a keepalive PING. If a response is not received within this
time period, the connection will be aborted. Note that in order to prevent the influence of
Head-of-line (HOL) blocking the timeout period is extended when *any* frame is received on
the connection, under the assumption that if a frame is received the connection is healthy.
      .google.protobuf.Duration timeout = 2 [(.validate.rules) = { ... }
      Returns:
      The timeout.

    • getTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
      How long to wait for a response to a keepalive PING. If a response is not received within this
time period, the connection will be aborted. Note that in order to prevent the influence of
Head-of-line (HOL) blocking the timeout period is extended when *any* frame is received on
the connection, under the assumption that if a frame is received the connection is healthy.
      .google.protobuf.Duration timeout = 2 [(.validate.rules) = { ... }

    • hasIntervalJitter

      boolean hasIntervalJitter()
      A random jitter amount as a percentage of interval that will be added to each interval.
A value of zero means there will be no jitter.
The default value is 15%.
      .envoy.type.v3.Percent interval_jitter = 3;
      Returns:
      Whether the intervalJitter field is set.

    • getIntervalJitter

      Percent getIntervalJitter()
      A random jitter amount as a percentage of interval that will be added to each interval.
A value of zero means there will be no jitter.
The default value is 15%.
      .envoy.type.v3.Percent interval_jitter = 3;
      Returns:
      The intervalJitter.

    • getIntervalJitterOrBuilder

      PercentOrBuilder getIntervalJitterOrBuilder()
      A random jitter amount as a percentage of interval that will be added to each interval.
A value of zero means there will be no jitter.
The default value is 15%.
      .envoy.type.v3.Percent interval_jitter = 3;

    • hasConnectionIdleInterval

      boolean hasConnectionIdleInterval()
      If the connection has been idle for this duration, send a HTTP/2 ping ahead
of new stream creation, to quickly detect dead connections.
If this is zero, this type of PING will not be sent.
If an interval ping is outstanding, a second ping will not be sent as the
interval ping will determine if the connection is dead.

The same feature for HTTP/3 is given by inheritance from QUICHE which uses :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` and the current PTO of the connection to decide whether to probe before sending a new request.
      .google.protobuf.Duration connection_idle_interval = 4 [(.validate.rules) = { ... }
      Returns:
      Whether the connectionIdleInterval field is set.

    • getConnectionIdleInterval

      com.google.protobuf.Duration getConnectionIdleInterval()
      If the connection has been idle for this duration, send a HTTP/2 ping ahead
of new stream creation, to quickly detect dead connections.
If this is zero, this type of PING will not be sent.
If an interval ping is outstanding, a second ping will not be sent as the
interval ping will determine if the connection is dead.

The same feature for HTTP/3 is given by inheritance from QUICHE which uses :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` and the current PTO of the connection to decide whether to probe before sending a new request.
      .google.protobuf.Duration connection_idle_interval = 4 [(.validate.rules) = { ... }
      Returns:
      The connectionIdleInterval.

    • getConnectionIdleIntervalOrBuilder

      com.google.protobuf.DurationOrBuilder getConnectionIdleIntervalOrBuilder()
      If the connection has been idle for this duration, send a HTTP/2 ping ahead
of new stream creation, to quickly detect dead connections.
If this is zero, this type of PING will not be sent.
If an interval ping is outstanding, a second ping will not be sent as the
interval ping will determine if the connection is dead.

The same feature for HTTP/3 is given by inheritance from QUICHE which uses :ref:`connection idle_timeout <envoy_v3_api_field_config.listener.v3.QuicProtocolOptions.idle_timeout>` and the current PTO of the connection to decide whether to probe before sending a new request.
      .google.protobuf.Duration connection_idle_interval = 4 [(.validate.rules) = { ... }