Struct QuicKeepAliveSettings 

pub struct QuicKeepAliveSettings {
    pub max_interval: Option<Duration>,
    pub initial_interval: Option<Duration>,
}

Config for keepalive probes in a QUIC connection. Note that QUIC keep-alive probing packets work differently from HTTP/2 keep-alive PINGs in a sense that the probing packet itself doesn’t timeout waiting for a probing response. Quic has a shorter idle timeout than TCP, so it doesn’t rely on such probing to discover dead connections. If the peer fails to respond, the connection will idle timeout eventually. Thus, they are configured differently from :ref:connection_keepalive <envoy_v3_api_field_config.core.v3.Http2ProtocolOptions.connection_keepalive>.

Fields

max_interval: Option<Duration>

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.

initial_interval: Option<Duration>

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.

Trait Implementations

impl Clone for QuicKeepAliveSettings

fn clone(&self) -> QuicKeepAliveSettings

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QuicKeepAliveSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QuicKeepAliveSettings

fn default() -> Self

Returns the “default value” for a type.

impl Message for QuicKeepAliveSettings

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl Name for QuicKeepAliveSettings

const NAME: &'static str = "QuicKeepAliveSettings"

Simple name for this Message. This name is the same as it appears in the source .proto file, e.g. FooBar.

const PACKAGE: &'static str = "envoy.config.core.v3"

Package name this message type is contained in. They are domain-like and delimited by ., e.g. google.protobuf.

fn full_name() -> String

Fully-qualified unique name for this Message. It’s prefixed with the package name and names of any parent messages, e.g. google.rpc.BadRequest.FieldViolation. By default, this is the package name followed by the message name. Fully-qualified names must be unique within a domain of Type URLs.

fn type_url() -> String

Type URL for this Message, which by default is the full name with a leading slash, but may also include a leading domain name, e.g. type.googleapis.com/google.profile.Person. This can be used when serializing into the google.protobuf.Any type.

impl PartialEq for QuicKeepAliveSettings

fn eq(&self, other: &QuicKeepAliveSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for QuicKeepAliveSettings

impl StructuralPartialEq for QuicKeepAliveSettings