Struct AlternateProtocolsCacheOptions

pub struct AlternateProtocolsCacheOptions {
    pub name: String,
    pub max_entries: Option<UInt32Value>,
    pub key_value_store_config: Option<TypedExtensionConfig>,
    pub prepopulated_entries: Vec<AlternateProtocolsCacheEntry>,
    pub canonical_suffixes: Vec<String>,
}

Configures the alternate protocols cache which tracks alternate protocols that can be used to make an HTTP connection to an origin server. See https://tools.ietf.org/html/rfc7838 for HTTP Alternative Services and https://datatracker.ietf.org/doc/html/draft-ietf-dnsop-svcb-https-04 for the “HTTPS” DNS resource record. [#next-free-field: 6]

Fields

name: String

The name of the cache. Multiple named caches allow independent alternate protocols cache configurations to operate within a single Envoy process using different configurations. All alternate protocols cache options with the same name must be equal in all fields when referenced from different configuration components. Configuration will fail to load if this is not the case.

max_entries: Option<UInt32Value>

The maximum number of entries that the cache will hold. If not specified defaults to 1024.

.. note:

The implementation is approximate and enforced independently on each worker thread, thus it is possible for the maximum entries in the cache to go slightly above the configured value depending on timing. This is similar to how other circuit breakers work.

key_value_store_config: Option<TypedExtensionConfig>

Allows configuring a persistent :ref:key value store <envoy_v3_api_msg_config.common.key_value.v3.KeyValueStoreConfig> to flush alternate protocols entries to disk. This function is currently only supported if concurrency is 1 Cached entries will take precedence over pre-populated entries below.

prepopulated_entries: Vec<AlternateProtocolsCacheEntry>

Allows pre-populating the cache with entries, as described above.

canonical_suffixes: Vec<String>

Optional list of hostnames suffixes for which Alt-Svc entries can be shared. For example, if this list contained the value .c.example.com, then an Alt-Svc entry for foo.c.example.com could be shared with bar.c.example.com but would not be shared with baz.example.com. On the other hand, if the list contained the value .example.com then all three hosts could share Alt-Svc entries. Each entry must start with .. If a hostname matches multiple suffixes, the first listed suffix will be used.

Since lookup in this list is O(n), it is recommended that the number of suffixes be limited. [#not-implemented-hide:]

Trait Implementations

impl Clone for AlternateProtocolsCacheOptions

fn clone(&self) -> AlternateProtocolsCacheOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlternateProtocolsCacheOptions

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

Formats the value using the given formatter.

impl Default for AlternateProtocolsCacheOptions

fn default() -> Self

Returns the “default value” for a type.

impl Message for AlternateProtocolsCacheOptions

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 AlternateProtocolsCacheOptions

const NAME: &'static str = "AlternateProtocolsCacheOptions"

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 AlternateProtocolsCacheOptions

fn eq(&self, other: &AlternateProtocolsCacheOptions) -> 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 StructuralPartialEq for AlternateProtocolsCacheOptions