listenerv3

package
v1.36.10-2025120520573... Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: unknown License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
const Filter_ConfigDiscovery_case case_Filter_ConfigType = 5
View Source 
const Filter_ConfigType_not_set_case case_Filter_ConfigType = 0
View Source 
const Filter_TypedConfig_case case_Filter_ConfigType = 4
View Source 
const ListenerFilterChainMatchPredicate_AndMatch_case case_ListenerFilterChainMatchPredicate_Rule = 2
View Source 
const ListenerFilterChainMatchPredicate_AnyMatch_case case_ListenerFilterChainMatchPredicate_Rule = 4
View Source 
const ListenerFilterChainMatchPredicate_DestinationPortRange_case case_ListenerFilterChainMatchPredicate_Rule = 5
View Source 
const ListenerFilterChainMatchPredicate_NotMatch_case case_ListenerFilterChainMatchPredicate_Rule = 3
View Source 
const ListenerFilterChainMatchPredicate_OrMatch_case case_ListenerFilterChainMatchPredicate_Rule = 1
View Source 
const ListenerFilterChainMatchPredicate_Rule_not_set_case case_ListenerFilterChainMatchPredicate_Rule = 0
View Source 
const ListenerFilter_ConfigDiscovery_case case_ListenerFilter_ConfigType = 5
View Source 
const ListenerFilter_ConfigType_not_set_case case_ListenerFilter_ConfigType = 0
View Source 
const ListenerFilter_TypedConfig_case case_ListenerFilter_ConfigType = 3
View Source 
const Listener_ConnectionBalanceConfig_BalanceType_not_set_case case_Listener_ConnectionBalanceConfig_BalanceType = 0
View Source 
const Listener_ConnectionBalanceConfig_ExactBalance_case case_Listener_ConnectionBalanceConfig_BalanceType = 1
View Source 
const Listener_ConnectionBalanceConfig_ExtendBalance_case case_Listener_ConnectionBalanceConfig_BalanceType = 2
View Source 
const Listener_InternalListener_case case_Listener_ListenerSpecifier = 27
View Source 
const Listener_ListenerSpecifier_not_set_case case_Listener_ListenerSpecifier = 0

Variables

View Source 
var (
	Listener_DrainType_name = map[int32]string{
		0: "DEFAULT",
		1: "MODIFY_ONLY",
	}
	Listener_DrainType_value = map[string]int32{
		"DEFAULT":     0,
		"MODIFY_ONLY": 1,
	}
)

Enum value maps for Listener_DrainType.

View Source 
var (
	FilterChainMatch_ConnectionSourceType_name = map[int32]string{
		0: "ANY",
		1: "SAME_IP_OR_LOOPBACK",
		2: "EXTERNAL",
	}
	FilterChainMatch_ConnectionSourceType_value = map[string]int32{
		"ANY":                 0,
		"SAME_IP_OR_LOOPBACK": 1,
		"EXTERNAL":            2,
	}
)

Enum value maps for FilterChainMatch_ConnectionSourceType.

View Source 
var File_envoy_config_listener_v3_api_listener_proto protoreflect.FileDescriptor
View Source 
var File_envoy_config_listener_v3_listener_components_proto protoreflect.FileDescriptor
View Source 
var File_envoy_config_listener_v3_listener_proto protoreflect.FileDescriptor
View Source 
var File_envoy_config_listener_v3_quic_config_proto protoreflect.FileDescriptor
View Source 
var File_envoy_config_listener_v3_udp_listener_config_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ActiveRawUdpListenerConfig 

type ActiveRawUdpListenerConfig struct {
	// contains filtered or unexported fields
}

func (*ActiveRawUdpListenerConfig) ProtoMessage 

func (*ActiveRawUdpListenerConfig) ProtoMessage()

func (*ActiveRawUdpListenerConfig) ProtoReflect 

func (x *ActiveRawUdpListenerConfig) ProtoReflect() protoreflect.Message

func (*ActiveRawUdpListenerConfig) Reset 

func (x *ActiveRawUdpListenerConfig) Reset()

func (*ActiveRawUdpListenerConfig) String 

func (x *ActiveRawUdpListenerConfig) String() string

type ActiveRawUdpListenerConfig_builder 

type ActiveRawUdpListenerConfig_builder struct {
	// contains filtered or unexported fields
}

func (ActiveRawUdpListenerConfig_builder) Build 

func (b0 ActiveRawUdpListenerConfig_builder) Build() *ActiveRawUdpListenerConfig

type AdditionalAddress 

type AdditionalAddress struct {
	Address *v3.Address `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
	// Additional socket options that may not be present in Envoy source code or
	// precompiled binaries. If specified, this will override the
	// :ref:`socket_options <envoy_v3_api_field_config.listener.v3.Listener.socket_options>`
	// in the listener. If specified with no
	// :ref:`socket_options <envoy_v3_api_field_config.core.v3.SocketOptionsOverride.socket_options>`
	// or an empty list of :ref:`socket_options <envoy_v3_api_field_config.core.v3.SocketOptionsOverride.socket_options>`,
	// it means no socket option will apply.
	SocketOptions *v3.SocketOptionsOverride `protobuf:"bytes,2,opt,name=socket_options,json=socketOptions,proto3" json:"socket_options,omitempty"`
	// contains filtered or unexported fields
}

The additional address the listener is listening on.

func (*AdditionalAddress) ClearAddress 

func (x *AdditionalAddress) ClearAddress()

func (*AdditionalAddress) ClearSocketOptions 

func (x *AdditionalAddress) ClearSocketOptions()

func (*AdditionalAddress) GetAddress 

func (x *AdditionalAddress) GetAddress() *v3.Address

func (*AdditionalAddress) GetSocketOptions 

func (x *AdditionalAddress) GetSocketOptions() *v3.SocketOptionsOverride

func (*AdditionalAddress) HasAddress 

func (x *AdditionalAddress) HasAddress() bool

func (*AdditionalAddress) HasSocketOptions 

func (x *AdditionalAddress) HasSocketOptions() bool

func (*AdditionalAddress) ProtoMessage 

func (*AdditionalAddress) ProtoMessage()

func (*AdditionalAddress) ProtoReflect 

func (x *AdditionalAddress) ProtoReflect() protoreflect.Message

func (*AdditionalAddress) Reset 

func (x *AdditionalAddress) Reset()

func (*AdditionalAddress) SetAddress 

func (x *AdditionalAddress) SetAddress(v *v3.Address)

func (*AdditionalAddress) SetSocketOptions 

func (x *AdditionalAddress) SetSocketOptions(v *v3.SocketOptionsOverride)

func (*AdditionalAddress) String 

func (x *AdditionalAddress) String() string

type AdditionalAddress_builder 

type AdditionalAddress_builder struct {
	Address *v3.Address
	// Additional socket options that may not be present in Envoy source code or
	// precompiled binaries. If specified, this will override the
	// :ref:`socket_options <envoy_v3_api_field_config.listener.v3.Listener.socket_options>`
	// in the listener. If specified with no
	// :ref:`socket_options <envoy_v3_api_field_config.core.v3.SocketOptionsOverride.socket_options>`
	// or an empty list of :ref:`socket_options <envoy_v3_api_field_config.core.v3.SocketOptionsOverride.socket_options>`,
	// it means no socket option will apply.
	SocketOptions *v3.SocketOptionsOverride
	// contains filtered or unexported fields
}

func (AdditionalAddress_builder) Build 

func (b0 AdditionalAddress_builder) Build() *AdditionalAddress

type ApiListener 

type ApiListener struct {

	// The type in this field determines the type of API listener. At present, the following
	// types are supported:
	// envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager (HTTP)
	// envoy.extensions.filters.network.http_connection_manager.v3.EnvoyMobileHttpConnectionManager (HTTP)
	// [#next-major-version: In the v3 API, replace this Any field with a oneof containing the
	// specific config message for each type of API listener. We could not do this in v2 because
	// it would have caused circular dependencies for go protos: lds.proto depends on this file,
	// and http_connection_manager.proto depends on rds.proto, which is in the same directory as
	// lds.proto, so lds.proto cannot depend on this file.]
	ApiListener *anypb.Any `protobuf:"bytes,1,opt,name=api_listener,json=apiListener,proto3" json:"api_listener,omitempty"`
	// contains filtered or unexported fields
}

Describes a type of API listener, which is used in non-proxy clients. The type of API exposed to the non-proxy application depends on the type of API listener.

func (*ApiListener) ClearApiListener 

func (x *ApiListener) ClearApiListener()

func (*ApiListener) GetApiListener 

func (x *ApiListener) GetApiListener() *anypb.Any

func (*ApiListener) HasApiListener 

func (x *ApiListener) HasApiListener() bool

func (*ApiListener) ProtoMessage 

func (*ApiListener) ProtoMessage()

func (*ApiListener) ProtoReflect 

func (x *ApiListener) ProtoReflect() protoreflect.Message

func (*ApiListener) Reset 

func (x *ApiListener) Reset()

func (*ApiListener) SetApiListener 

func (x *ApiListener) SetApiListener(v *anypb.Any)

func (*ApiListener) String 

func (x *ApiListener) String() string

type ApiListenerManager 

type ApiListenerManager struct {
	// contains filtered or unexported fields
}

A placeholder proto so that users can explicitly configure the API Listener Manager via the bootstrap's :ref:`listener_manager <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.listener_manager>`. [#not-implemented-hide:]

func (*ApiListenerManager) ProtoMessage 

func (*ApiListenerManager) ProtoMessage()

func (*ApiListenerManager) ProtoReflect 

func (x *ApiListenerManager) ProtoReflect() protoreflect.Message

func (*ApiListenerManager) Reset 

func (x *ApiListenerManager) Reset()

func (*ApiListenerManager) String 

func (x *ApiListenerManager) String() string

type ApiListenerManager_builder 

type ApiListenerManager_builder struct {
	// contains filtered or unexported fields
}

func (ApiListenerManager_builder) Build 

func (b0 ApiListenerManager_builder) Build() *ApiListenerManager

type ApiListener_builder 

type ApiListener_builder struct {

	// The type in this field determines the type of API listener. At present, the following
	// types are supported:
	// envoy.extensions.filters.network.http_connection_manager.v3.HttpConnectionManager (HTTP)
	// envoy.extensions.filters.network.http_connection_manager.v3.EnvoyMobileHttpConnectionManager (HTTP)
	// [#next-major-version: In the v3 API, replace this Any field with a oneof containing the
	// specific config message for each type of API listener. We could not do this in v2 because
	// it would have caused circular dependencies for go protos: lds.proto depends on this file,
	// and http_connection_manager.proto depends on rds.proto, which is in the same directory as
	// lds.proto, so lds.proto cannot depend on this file.]
	ApiListener *anypb.Any
	// contains filtered or unexported fields
}

func (ApiListener_builder) Build 

func (b0 ApiListener_builder) Build() *ApiListener

type Filter 

type Filter struct {

	// The name of the filter configuration.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are valid to be assigned to ConfigType:
	//
	//	*Filter_TypedConfig
	//	*Filter_ConfigDiscovery
	ConfigType isFilter_ConfigType `protobuf_oneof:"config_type"`
	// contains filtered or unexported fields
}

[#next-free-field: 6]

func (*Filter) ClearConfigDiscovery 

func (x *Filter) ClearConfigDiscovery()

func (*Filter) ClearConfigType 

func (x *Filter) ClearConfigType()

func (*Filter) ClearTypedConfig 

func (x *Filter) ClearTypedConfig()

func (*Filter) GetConfigDiscovery 

func (x *Filter) GetConfigDiscovery() *v3.ExtensionConfigSource

func (*Filter) GetConfigType 

func (x *Filter) GetConfigType() isFilter_ConfigType

func (*Filter) GetName 

func (x *Filter) GetName() string

func (*Filter) GetTypedConfig 

func (x *Filter) GetTypedConfig() *anypb.Any

func (*Filter) HasConfigDiscovery 

func (x *Filter) HasConfigDiscovery() bool

func (*Filter) HasConfigType 

func (x *Filter) HasConfigType() bool

func (*Filter) HasTypedConfig 

func (x *Filter) HasTypedConfig() bool

func (*Filter) ProtoMessage 

func (*Filter) ProtoMessage()

func (*Filter) ProtoReflect 

func (x *Filter) ProtoReflect() protoreflect.Message

func (*Filter) Reset 

func (x *Filter) Reset()

func (*Filter) SetConfigDiscovery 

func (x *Filter) SetConfigDiscovery(v *v3.ExtensionConfigSource)

func (*Filter) SetName 

func (x *Filter) SetName(v string)

func (*Filter) SetTypedConfig 

func (x *Filter) SetTypedConfig(v *anypb.Any)

func (*Filter) String 

func (x *Filter) String() string

func (*Filter) WhichConfigType 

func (x *Filter) WhichConfigType() case_Filter_ConfigType

type FilterChain 

type FilterChain struct {

	// The criteria to use when matching a connection to this filter chain.
	FilterChainMatch *FilterChainMatch `protobuf:"bytes,1,opt,name=filter_chain_match,json=filterChainMatch,proto3" json:"filter_chain_match,omitempty"`
	// A list of individual network filters that make up the filter chain for
	// connections established with the listener. Order matters as the filters are
	// processed sequentially as connection events happen. Note: If the filter
	// list is empty, the connection will close by default.
	//
	// For QUIC listeners, network filters other than HTTP Connection Manager (HCM)
	// can be created, but due to differences in the connection implementation compared
	// to TCP, the onData() method will never be called. Therefore, network filters
	// for QUIC listeners should only expect to do work at the start of a new connection
	// (i.e. in onNewConnection()). HCM must be the last (or only) filter in the chain.
	Filters []*Filter `protobuf:"bytes,3,rep,name=filters,proto3" json:"filters,omitempty"`
	// Whether the listener should expect a PROXY protocol V1 header on new
	// connections. If this option is enabled, the listener will assume that that
	// remote address of the connection is the one specified in the header. Some
	// load balancers including the AWS ELB support this option. If the option is
	// absent or set to false, Envoy will use the physical peer address of the
	// connection as the remote address.
	//
	// This field is deprecated. Add a
	// :ref:`PROXY protocol listener filter <config_listener_filters_proxy_protocol>`
	// explicitly instead.
	//
	// Deprecated: Marked as deprecated in envoy/config/listener/v3/listener_components.proto.
	UseProxyProto *wrapperspb.BoolValue `protobuf:"bytes,4,opt,name=use_proxy_proto,json=useProxyProto,proto3" json:"use_proxy_proto,omitempty"`
	// Filter chain metadata.
	Metadata *v3.Metadata `protobuf:"bytes,5,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// Optional custom transport socket implementation to use for downstream connections.
	// To setup TLS, set a transport socket with name “envoy.transport_sockets.tls“ and
	// :ref:`DownstreamTlsContext <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.DownstreamTlsContext>` in the “typed_config“.
	// If no transport socket configuration is specified, new connections
	// will be set up with plaintext.
	// [#extension-category: envoy.transport_sockets.downstream]
	TransportSocket *v3.TransportSocket `protobuf:"bytes,6,opt,name=transport_socket,json=transportSocket,proto3" json:"transport_socket,omitempty"`
	// If present and nonzero, the amount of time to allow incoming connections to complete any
	// transport socket negotiations. If this expires before the transport reports connection
	// establishment, the connection is summarily closed.
	TransportSocketConnectTimeout *durationpb.Duration `` /* 152-byte string literal not displayed */
	// The unique name (or empty) by which this filter chain is known.
	// Note: :ref:`filter_chain_matcher
	// <envoy_v3_api_field_config.listener.v3.Listener.filter_chain_matcher>`
	// requires that filter chains are uniquely named within a listener.
	Name string `protobuf:"bytes,7,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A filter chain wraps a set of match criteria, an option TLS context, a set of filters, and various other parameters. [#next-free-field: 10]

func (*FilterChain) ClearFilterChainMatch 

func (x *FilterChain) ClearFilterChainMatch()

func (*FilterChain) ClearMetadata 

func (x *FilterChain) ClearMetadata()

func (*FilterChain) ClearTransportSocket 

func (x *FilterChain) ClearTransportSocket()

func (*FilterChain) ClearTransportSocketConnectTimeout 

func (x *FilterChain) ClearTransportSocketConnectTimeout()

func (*FilterChain) ClearUseProxyProto deprecated 

func (x *FilterChain) ClearUseProxyProto()

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener_components.proto.

func (*FilterChain) GetFilterChainMatch 

func (x *FilterChain) GetFilterChainMatch() *FilterChainMatch

func (*FilterChain) GetFilters 

func (x *FilterChain) GetFilters() []*Filter

func (*FilterChain) GetMetadata 

func (x *FilterChain) GetMetadata() *v3.Metadata

func (*FilterChain) GetName 

func (x *FilterChain) GetName() string

func (*FilterChain) GetTransportSocket 

func (x *FilterChain) GetTransportSocket() *v3.TransportSocket

func (*FilterChain) GetTransportSocketConnectTimeout 

func (x *FilterChain) GetTransportSocketConnectTimeout() *durationpb.Duration

func (*FilterChain) GetUseProxyProto deprecated 

func (x *FilterChain) GetUseProxyProto() *wrapperspb.BoolValue

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener_components.proto.

func (*FilterChain) HasFilterChainMatch 

func (x *FilterChain) HasFilterChainMatch() bool

func (*FilterChain) HasMetadata 

func (x *FilterChain) HasMetadata() bool

func (*FilterChain) HasTransportSocket 

func (x *FilterChain) HasTransportSocket() bool

func (*FilterChain) HasTransportSocketConnectTimeout 

func (x *FilterChain) HasTransportSocketConnectTimeout() bool

func (*FilterChain) HasUseProxyProto deprecated 

func (x *FilterChain) HasUseProxyProto() bool

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener_components.proto.

func (*FilterChain) ProtoMessage 

func (*FilterChain) ProtoMessage()

func (*FilterChain) ProtoReflect 

func (x *FilterChain) ProtoReflect() protoreflect.Message

func (*FilterChain) Reset 

func (x *FilterChain) Reset()

func (*FilterChain) SetFilterChainMatch 

func (x *FilterChain) SetFilterChainMatch(v *FilterChainMatch)

func (*FilterChain) SetFilters 

func (x *FilterChain) SetFilters(v []*Filter)

func (*FilterChain) SetMetadata 

func (x *FilterChain) SetMetadata(v *v3.Metadata)

func (*FilterChain) SetName 

func (x *FilterChain) SetName(v string)

func (*FilterChain) SetTransportSocket 

func (x *FilterChain) SetTransportSocket(v *v3.TransportSocket)

func (*FilterChain) SetTransportSocketConnectTimeout 

func (x *FilterChain) SetTransportSocketConnectTimeout(v *durationpb.Duration)

func (*FilterChain) SetUseProxyProto deprecated 

func (x *FilterChain) SetUseProxyProto(v *wrapperspb.BoolValue)

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener_components.proto.

func (*FilterChain) String 

func (x *FilterChain) String() string

type FilterChainMatch 

type FilterChainMatch struct {

	// Optional destination port to consider when use_original_dst is set on the
	// listener in determining a filter chain match.
	DestinationPort *wrapperspb.UInt32Value `protobuf:"bytes,8,opt,name=destination_port,json=destinationPort,proto3" json:"destination_port,omitempty"`
	// If non-empty, an IP address and prefix length to match addresses when the
	// listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
	PrefixRanges []*v3.CidrRange `protobuf:"bytes,3,rep,name=prefix_ranges,json=prefixRanges,proto3" json:"prefix_ranges,omitempty"`
	// If non-empty, an IP address and suffix length to match addresses when the
	// listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
	// [#not-implemented-hide:]
	AddressSuffix string `protobuf:"bytes,4,opt,name=address_suffix,json=addressSuffix,proto3" json:"address_suffix,omitempty"`
	// [#not-implemented-hide:]
	SuffixLen *wrapperspb.UInt32Value `protobuf:"bytes,5,opt,name=suffix_len,json=suffixLen,proto3" json:"suffix_len,omitempty"`
	// The criteria is satisfied if the directly connected source IP address of the downstream
	// connection is contained in at least one of the specified subnets. If the parameter is not
	// specified or the list is empty, the directly connected source IP address is ignored.
	DirectSourcePrefixRanges []*v3.CidrRange `` /* 138-byte string literal not displayed */
	// Specifies the connection source IP match type. Can be any, local or external network.
	SourceType FilterChainMatch_ConnectionSourceType `` /* 161-byte string literal not displayed */
	// The criteria is satisfied if the source IP address of the downstream
	// connection is contained in at least one of the specified subnets. If the
	// parameter is not specified or the list is empty, the source IP address is
	// ignored.
	SourcePrefixRanges []*v3.CidrRange `protobuf:"bytes,6,rep,name=source_prefix_ranges,json=sourcePrefixRanges,proto3" json:"source_prefix_ranges,omitempty"`
	// The criteria is satisfied if the source port of the downstream connection
	// is contained in at least one of the specified ports. If the parameter is
	// not specified, the source port is ignored.
	SourcePorts []uint32 `protobuf:"varint,7,rep,packed,name=source_ports,json=sourcePorts,proto3" json:"source_ports,omitempty"`
	// If non-empty, a list of server names (e.g. SNI for TLS protocol) to consider when determining
	// a filter chain match. Those values will be compared against the server names of a new
	// connection, when detected by one of the listener filters.
	//
	// The server name will be matched against all wildcard domains, i.e. “www.example.com“
	// will be first matched against “www.example.com“, then “*.example.com“, then “*.com“.
	//
	// Note that partial wildcards are not supported, and values like “*w.example.com“ are invalid.
	// The value “*“ is also not supported, and “server_names“ should be omitted instead.
	//
	// .. attention::
	//
	//	See the :ref:`FAQ entry <faq_how_to_setup_sni>` on how to configure SNI for more
	//	information.
	ServerNames []string `protobuf:"bytes,11,rep,name=server_names,json=serverNames,proto3" json:"server_names,omitempty"`
	// If non-empty, a transport protocol to consider when determining a filter chain match.
	// This value will be compared against the transport protocol of a new connection, when
	// it's detected by one of the listener filters.
	//
	// Suggested values include:
	//
	//   - “raw_buffer“ - default, used when no transport protocol is detected,
	//   - “tls“ - set by :ref:`envoy.filters.listener.tls_inspector <config_listener_filters_tls_inspector>`
	//     when TLS protocol is detected.
	TransportProtocol string `protobuf:"bytes,9,opt,name=transport_protocol,json=transportProtocol,proto3" json:"transport_protocol,omitempty"`
	// If non-empty, a list of application protocols (e.g. ALPN for TLS protocol) to consider when
	// determining a filter chain match. Those values will be compared against the application
	// protocols of a new connection, when detected by one of the listener filters.
	//
	// Suggested values include:
	//
	//   - “http/1.1“ - set by :ref:`envoy.filters.listener.tls_inspector
	//     <config_listener_filters_tls_inspector>`,
	//   - “h2“ - set by :ref:`envoy.filters.listener.tls_inspector <config_listener_filters_tls_inspector>`
	//
	// .. attention::
	//
	//	Currently, only :ref:`TLS Inspector <config_listener_filters_tls_inspector>` provides
	//	application protocol detection based on the requested
	//	`ALPN <https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation>`_ values.
	//
	//	However, the use of ALPN is pretty much limited to the HTTP/2 traffic on the Internet,
	//	and matching on values other than “h2“ is going to lead to a lot of false negatives,
	//	unless all connecting clients are known to use ALPN.
	ApplicationProtocols []string `protobuf:"bytes,10,rep,name=application_protocols,json=applicationProtocols,proto3" json:"application_protocols,omitempty"`
	// contains filtered or unexported fields
}

Specifies the match criteria for selecting a specific filter chain for a listener.

In order for a filter chain to be selected, *ALL* of its criteria must be fulfilled by the incoming connection, properties of which are set by the networking stack and/or listener filters.

The following order applies:

  1. Destination port.
  2. Destination IP address.
  3. Server name (e.g. SNI for TLS protocol),
  4. Transport protocol.
  5. Application protocols (e.g. ALPN for TLS protocol).
  6. Directly connected source IP address (this will only be different from the source IP address when using a listener filter that overrides the source address, such as the :ref:`Proxy Protocol listener filter <config_listener_filters_proxy_protocol>`).
  7. Source type (e.g. any, local or external network).
  8. Source IP address.
  9. Source port.

For criteria that allow ranges or wildcards, the most specific value in any of the configured filter chains that matches the incoming connection is going to be used (e.g. for SNI “www.example.com“ the most specific match would be “www.example.com“, then “*.example.com“, then “*.com“, then any filter chain without “server_names“ requirements).

A different way to reason about the filter chain matches: Suppose there exists N filter chains. Prune the filter chain set using the above 8 steps. In each step, filter chains which most specifically matches the attributes continue to the next step. The listener guarantees at most 1 filter chain is left after all of the steps.

Example:

For destination port, filter chains specifying the destination port of incoming traffic are the most specific match. If none of the filter chains specifies the exact destination port, the filter chains which do not specify ports are the most specific match. Filter chains specifying the wrong port can never be the most specific match.

[#comment: Implemented rules are kept in the preference order, with deprecated fields listed at the end, because that's how we want to list them in the docs.

[#comment:TODO(PiotrSikora): Add support for configurable precedence of the rules] [#next-free-field: 14]

func (*FilterChainMatch) ClearDestinationPort 

func (x *FilterChainMatch) ClearDestinationPort()

func (*FilterChainMatch) ClearSuffixLen 

func (x *FilterChainMatch) ClearSuffixLen()

func (*FilterChainMatch) GetAddressSuffix 

func (x *FilterChainMatch) GetAddressSuffix() string

func (*FilterChainMatch) GetApplicationProtocols 

func (x *FilterChainMatch) GetApplicationProtocols() []string

func (*FilterChainMatch) GetDestinationPort 

func (x *FilterChainMatch) GetDestinationPort() *wrapperspb.UInt32Value

func (*FilterChainMatch) GetDirectSourcePrefixRanges 

func (x *FilterChainMatch) GetDirectSourcePrefixRanges() []*v3.CidrRange

func (*FilterChainMatch) GetPrefixRanges 

func (x *FilterChainMatch) GetPrefixRanges() []*v3.CidrRange

func (*FilterChainMatch) GetServerNames 

func (x *FilterChainMatch) GetServerNames() []string

func (*FilterChainMatch) GetSourcePorts 

func (x *FilterChainMatch) GetSourcePorts() []uint32

func (*FilterChainMatch) GetSourcePrefixRanges 

func (x *FilterChainMatch) GetSourcePrefixRanges() []*v3.CidrRange

func (*FilterChainMatch) GetSourceType 

func (x *FilterChainMatch) GetSourceType() FilterChainMatch_ConnectionSourceType

func (*FilterChainMatch) GetSuffixLen 

func (x *FilterChainMatch) GetSuffixLen() *wrapperspb.UInt32Value

func (*FilterChainMatch) GetTransportProtocol 

func (x *FilterChainMatch) GetTransportProtocol() string

func (*FilterChainMatch) HasDestinationPort 

func (x *FilterChainMatch) HasDestinationPort() bool

func (*FilterChainMatch) HasSuffixLen 

func (x *FilterChainMatch) HasSuffixLen() bool

func (*FilterChainMatch) ProtoMessage 

func (*FilterChainMatch) ProtoMessage()

func (*FilterChainMatch) ProtoReflect 

func (x *FilterChainMatch) ProtoReflect() protoreflect.Message

func (*FilterChainMatch) Reset 

func (x *FilterChainMatch) Reset()

func (*FilterChainMatch) SetAddressSuffix 

func (x *FilterChainMatch) SetAddressSuffix(v string)

func (*FilterChainMatch) SetApplicationProtocols 

func (x *FilterChainMatch) SetApplicationProtocols(v []string)

func (*FilterChainMatch) SetDestinationPort 

func (x *FilterChainMatch) SetDestinationPort(v *wrapperspb.UInt32Value)

func (*FilterChainMatch) SetDirectSourcePrefixRanges 

func (x *FilterChainMatch) SetDirectSourcePrefixRanges(v []*v3.CidrRange)

func (*FilterChainMatch) SetPrefixRanges 

func (x *FilterChainMatch) SetPrefixRanges(v []*v3.CidrRange)

func (*FilterChainMatch) SetServerNames 

func (x *FilterChainMatch) SetServerNames(v []string)

func (*FilterChainMatch) SetSourcePorts 

func (x *FilterChainMatch) SetSourcePorts(v []uint32)

func (*FilterChainMatch) SetSourcePrefixRanges 

func (x *FilterChainMatch) SetSourcePrefixRanges(v []*v3.CidrRange)

func (*FilterChainMatch) SetSourceType 

func (x *FilterChainMatch) SetSourceType(v FilterChainMatch_ConnectionSourceType)

func (*FilterChainMatch) SetSuffixLen 

func (x *FilterChainMatch) SetSuffixLen(v *wrapperspb.UInt32Value)

func (*FilterChainMatch) SetTransportProtocol 

func (x *FilterChainMatch) SetTransportProtocol(v string)

func (*FilterChainMatch) String 

func (x *FilterChainMatch) String() string

type FilterChainMatch_ConnectionSourceType 

type FilterChainMatch_ConnectionSourceType int32
const (
	// Any connection source matches.
	FilterChainMatch_ANY FilterChainMatch_ConnectionSourceType = 0
	// Match a connection originating from the same host.
	FilterChainMatch_SAME_IP_OR_LOOPBACK FilterChainMatch_ConnectionSourceType = 1
	// Match a connection originating from a different host.
	FilterChainMatch_EXTERNAL FilterChainMatch_ConnectionSourceType = 2
)

func (FilterChainMatch_ConnectionSourceType) Descriptor 

func (FilterChainMatch_ConnectionSourceType) Descriptor() protoreflect.EnumDescriptor

func (FilterChainMatch_ConnectionSourceType) Enum 

func (x FilterChainMatch_ConnectionSourceType) Enum() *FilterChainMatch_ConnectionSourceType

func (FilterChainMatch_ConnectionSourceType) Number 

func (x FilterChainMatch_ConnectionSourceType) Number() protoreflect.EnumNumber

func (FilterChainMatch_ConnectionSourceType) String 

func (x FilterChainMatch_ConnectionSourceType) String() string

func (FilterChainMatch_ConnectionSourceType) Type 

func (FilterChainMatch_ConnectionSourceType) Type() protoreflect.EnumType

type FilterChainMatch_builder 

type FilterChainMatch_builder struct {

	// Optional destination port to consider when use_original_dst is set on the
	// listener in determining a filter chain match.
	DestinationPort *wrapperspb.UInt32Value
	// If non-empty, an IP address and prefix length to match addresses when the
	// listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
	PrefixRanges []*v3.CidrRange
	// If non-empty, an IP address and suffix length to match addresses when the
	// listener is bound to 0.0.0.0/:: or when use_original_dst is specified.
	// [#not-implemented-hide:]
	AddressSuffix string
	// [#not-implemented-hide:]
	SuffixLen *wrapperspb.UInt32Value
	// The criteria is satisfied if the directly connected source IP address of the downstream
	// connection is contained in at least one of the specified subnets. If the parameter is not
	// specified or the list is empty, the directly connected source IP address is ignored.
	DirectSourcePrefixRanges []*v3.CidrRange
	// Specifies the connection source IP match type. Can be any, local or external network.
	SourceType FilterChainMatch_ConnectionSourceType
	// The criteria is satisfied if the source IP address of the downstream
	// connection is contained in at least one of the specified subnets. If the
	// parameter is not specified or the list is empty, the source IP address is
	// ignored.
	SourcePrefixRanges []*v3.CidrRange
	// The criteria is satisfied if the source port of the downstream connection
	// is contained in at least one of the specified ports. If the parameter is
	// not specified, the source port is ignored.
	SourcePorts []uint32
	// If non-empty, a list of server names (e.g. SNI for TLS protocol) to consider when determining
	// a filter chain match. Those values will be compared against the server names of a new
	// connection, when detected by one of the listener filters.
	//
	// The server name will be matched against all wildcard domains, i.e. “www.example.com“
	// will be first matched against “www.example.com“, then “*.example.com“, then “*.com“.
	//
	// Note that partial wildcards are not supported, and values like “*w.example.com“ are invalid.
	// The value “*“ is also not supported, and “server_names“ should be omitted instead.
	//
	// .. attention::
	//
	//	See the :ref:`FAQ entry <faq_how_to_setup_sni>` on how to configure SNI for more
	//	information.
	ServerNames []string
	// If non-empty, a transport protocol to consider when determining a filter chain match.
	// This value will be compared against the transport protocol of a new connection, when
	// it's detected by one of the listener filters.
	//
	// Suggested values include:
	//
	//   - “raw_buffer“ - default, used when no transport protocol is detected,
	//   - “tls“ - set by :ref:`envoy.filters.listener.tls_inspector <config_listener_filters_tls_inspector>`
	//     when TLS protocol is detected.
	TransportProtocol string
	// If non-empty, a list of application protocols (e.g. ALPN for TLS protocol) to consider when
	// determining a filter chain match. Those values will be compared against the application
	// protocols of a new connection, when detected by one of the listener filters.
	//
	// Suggested values include:
	//
	//   - “http/1.1“ - set by :ref:`envoy.filters.listener.tls_inspector
	//     <config_listener_filters_tls_inspector>`,
	//   - “h2“ - set by :ref:`envoy.filters.listener.tls_inspector <config_listener_filters_tls_inspector>`
	//
	// .. attention::
	//
	//	Currently, only :ref:`TLS Inspector <config_listener_filters_tls_inspector>` provides
	//	application protocol detection based on the requested
	//	`ALPN <https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation>`_ values.
	//
	//	However, the use of ALPN is pretty much limited to the HTTP/2 traffic on the Internet,
	//	and matching on values other than “h2“ is going to lead to a lot of false negatives,
	//	unless all connecting clients are known to use ALPN.
	ApplicationProtocols []string
	// contains filtered or unexported fields
}

func (FilterChainMatch_builder) Build 

func (b0 FilterChainMatch_builder) Build() *FilterChainMatch

type FilterChain_builder 

type FilterChain_builder struct {

	// The criteria to use when matching a connection to this filter chain.
	FilterChainMatch *FilterChainMatch
	// A list of individual network filters that make up the filter chain for
	// connections established with the listener. Order matters as the filters are
	// processed sequentially as connection events happen. Note: If the filter
	// list is empty, the connection will close by default.
	//
	// For QUIC listeners, network filters other than HTTP Connection Manager (HCM)
	// can be created, but due to differences in the connection implementation compared
	// to TCP, the onData() method will never be called. Therefore, network filters
	// for QUIC listeners should only expect to do work at the start of a new connection
	// (i.e. in onNewConnection()). HCM must be the last (or only) filter in the chain.
	Filters []*Filter
	// Whether the listener should expect a PROXY protocol V1 header on new
	// connections. If this option is enabled, the listener will assume that that
	// remote address of the connection is the one specified in the header. Some
	// load balancers including the AWS ELB support this option. If the option is
	// absent or set to false, Envoy will use the physical peer address of the
	// connection as the remote address.
	//
	// This field is deprecated. Add a
	// :ref:`PROXY protocol listener filter <config_listener_filters_proxy_protocol>`
	// explicitly instead.
	//
	// Deprecated: Marked as deprecated in envoy/config/listener/v3/listener_components.proto.
	UseProxyProto *wrapperspb.BoolValue
	// Filter chain metadata.
	Metadata *v3.Metadata
	// Optional custom transport socket implementation to use for downstream connections.
	// To setup TLS, set a transport socket with name “envoy.transport_sockets.tls“ and
	// :ref:`DownstreamTlsContext <envoy_v3_api_msg_extensions.transport_sockets.tls.v3.DownstreamTlsContext>` in the “typed_config“.
	// If no transport socket configuration is specified, new connections
	// will be set up with plaintext.
	// [#extension-category: envoy.transport_sockets.downstream]
	TransportSocket *v3.TransportSocket
	// If present and nonzero, the amount of time to allow incoming connections to complete any
	// transport socket negotiations. If this expires before the transport reports connection
	// establishment, the connection is summarily closed.
	TransportSocketConnectTimeout *durationpb.Duration
	// The unique name (or empty) by which this filter chain is known.
	// Note: :ref:`filter_chain_matcher
	// <envoy_v3_api_field_config.listener.v3.Listener.filter_chain_matcher>`
	// requires that filter chains are uniquely named within a listener.
	Name string
	// contains filtered or unexported fields
}

func (FilterChain_builder) Build 

func (b0 FilterChain_builder) Build() *FilterChain

type Filter_ConfigDiscovery 

type Filter_ConfigDiscovery struct {
	// Configuration source specifier for an extension configuration discovery
	// service. In case of a failure and without the default configuration, the
	// listener closes the connections.
	ConfigDiscovery *v3.ExtensionConfigSource `protobuf:"bytes,5,opt,name=config_discovery,json=configDiscovery,proto3,oneof"`
}

type Filter_TypedConfig 

type Filter_TypedConfig struct {
	// Filter specific configuration which depends on the filter being
	// instantiated. See the supported filters for further documentation.
	// [#extension-category: envoy.filters.network]
	TypedConfig *anypb.Any `protobuf:"bytes,4,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

type Filter_builder 

type Filter_builder struct {

	// The name of the filter configuration.
	Name string
	// Fields of oneof ConfigType:
	// Filter specific configuration which depends on the filter being
	// instantiated. See the supported filters for further documentation.
	// [#extension-category: envoy.filters.network]
	TypedConfig *anypb.Any
	// Configuration source specifier for an extension configuration discovery
	// service. In case of a failure and without the default configuration, the
	// listener closes the connections.
	ConfigDiscovery *v3.ExtensionConfigSource
	// contains filtered or unexported fields
}

func (Filter_builder) Build 

func (b0 Filter_builder) Build() *Filter

type Listener 

type Listener struct {

	// The unique name by which this listener is known. If no name is provided,
	// Envoy will allocate an internal UUID for the listener. If the listener is to be dynamically
	// updated or removed via :ref:`LDS <config_listeners_lds>` a unique name must be provided.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The address that the listener should listen on. In general, the address must be unique, though
	// that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
	// Linux as the actual port will be allocated by the OS.
	// Required unless “api_listener“ or “listener_specifier“ is populated.
	Address *v3.Address `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// The additional addresses the listener should listen on. The addresses must be unique across all
	// listeners. Multiple addresses with port 0 can be supplied. When using multiple addresses in a single listener,
	// all addresses use the same protocol, and multiple internal addresses are not supported.
	AdditionalAddresses []*AdditionalAddress `protobuf:"bytes,33,rep,name=additional_addresses,json=additionalAddresses,proto3" json:"additional_addresses,omitempty"`
	// Optional prefix to use on listener stats. If empty, the stats will be rooted at
	// “listener.<address as string>.“. If non-empty, stats will be rooted at
	// “listener.<stat_prefix>.“.
	StatPrefix string `protobuf:"bytes,28,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// A list of filter chains to consider for this listener. The
	// :ref:`FilterChain <envoy_v3_api_msg_config.listener.v3.FilterChain>` with the most specific
	// :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` criteria is used on a
	// connection.
	//
	// Example using SNI for filter chain selection can be found in the
	// :ref:`FAQ entry <faq_how_to_setup_sni>`.
	FilterChains []*FilterChain `protobuf:"bytes,3,rep,name=filter_chains,json=filterChains,proto3" json:"filter_chains,omitempty"`
	// Discover filter chains configurations by external service. Dynamic discovery of filter chains is allowed
	// while having statically configured filter chains, however, a filter chain name must be unique within a
	// listener. If a discovered filter chain matches a name of an existing filter chain, it is discarded.
	// [#not-implemented-hide:]
	FcdsConfig *Listener_FcdsConfig `protobuf:"bytes,36,opt,name=fcds_config,json=fcdsConfig,proto3" json:"fcds_config,omitempty"`
	// :ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the
	// network properties. This matcher is used as a replacement for the filter chain match condition
	// :ref:`filter_chain_match
	// <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>`. If specified, all
	// :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>` must have a
	// non-empty and unique :ref:`name <envoy_v3_api_field_config.listener.v3.FilterChain.name>` field
	// and not specify :ref:`filter_chain_match
	// <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>` field.
	//
	// .. note::
	//
	//	Once matched, each connection is permanently bound to its filter chain.
	//	If the matcher changes but the filter chain remains the same, the
	//	connections bound to the filter chain are not drained. If, however, the
	//	filter chain is removed or structurally modified, then the drain for its
	//	connections is initiated.
	FilterChainMatcher *v32.Matcher `protobuf:"bytes,32,opt,name=filter_chain_matcher,json=filterChainMatcher,proto3" json:"filter_chain_matcher,omitempty"`
	// If a connection is redirected using “iptables“, the port on which the proxy
	// receives it might be different from the original destination address. When this flag is set to
	// true, the listener hands off redirected connections to the listener associated with the
	// original destination address. If there is no listener associated with the original destination
	// address, the connection is handled by the listener that receives it. Defaults to false.
	UseOriginalDst *wrapperspb.BoolValue `protobuf:"bytes,4,opt,name=use_original_dst,json=useOriginalDst,proto3" json:"use_original_dst,omitempty"`
	// The default filter chain if none of the filter chain matches. If no default filter chain is supplied,
	// the connection will be closed. The filter chain match is ignored in this field.
	DefaultFilterChain *FilterChain `protobuf:"bytes,25,opt,name=default_filter_chain,json=defaultFilterChain,proto3" json:"default_filter_chain,omitempty"`
	// Soft limit on size of the listener’s new connection read and write buffers.
	// If unspecified, an implementation defined default is applied (1MiB).
	PerConnectionBufferLimitBytes *wrapperspb.UInt32Value `` /* 154-byte string literal not displayed */
	// Listener metadata.
	Metadata *v3.Metadata `protobuf:"bytes,6,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// [#not-implemented-hide:]
	//
	// Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.
	DeprecatedV1 *Listener_DeprecatedV1 `protobuf:"bytes,7,opt,name=deprecated_v1,json=deprecatedV1,proto3" json:"deprecated_v1,omitempty"`
	// The type of draining to perform at a listener-wide level.
	DrainType Listener_DrainType `` /* 138-byte string literal not displayed */
	// Listener filters have the opportunity to manipulate and augment the connection metadata that
	// is used in connection filter chain matching, for example. These filters are run before any in
	// :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>`. Order matters as the
	// filters are processed sequentially right after a socket has been accepted by the listener, and
	// before a connection is created.
	// UDP Listener filters can be specified when the protocol in the listener socket address in
	// :ref:`protocol <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
	// <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>` and no
	// :ref:`quic_options <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
	// QUIC listener filters can be specified when :ref:`quic_options
	// <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is
	// specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
	// They are processed sequentially right before connection creation. And like TCP Listener filters, they can be used to manipulate the connection metadata and socket. But the difference is that they can't be used to pause connection creation.
	ListenerFilters []*ListenerFilter `protobuf:"bytes,9,rep,name=listener_filters,json=listenerFilters,proto3" json:"listener_filters,omitempty"`
	// The timeout to wait for all listener filters to complete operation. If the timeout is reached,
	// the accepted socket is closed without a connection being created unless
	// “continue_on_listener_filters_timeout“ is set to true. Specify 0 to disable the
	// timeout. If not specified, a default timeout of 15s is used.
	ListenerFiltersTimeout *durationpb.Duration `` /* 130-byte string literal not displayed */
	// Whether a connection should be created when listener filters timeout. Default is false.
	//
	// .. attention::
	//
	//	Some listener filters, such as :ref:`Proxy Protocol filter
	//	<config_listener_filters_proxy_protocol>`, should not be used with this option. It will cause
	//	unexpected behavior when a connection is created.
	ContinueOnListenerFiltersTimeout bool `` /* 165-byte string literal not displayed */
	// Whether the listener should be set as a transparent socket.
	// When this flag is set to true, connections can be redirected to the listener using an
	// “iptables“ “TPROXY“ target, in which case the original source and destination addresses and
	// ports are preserved on accepted connections. This flag should be used in combination with
	// :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
	// <envoy_v3_api_field_config.listener.v3.Listener.listener_filters>` to mark the connections' local addresses as
	// "restored." This can be used to hand off each redirected connection to another listener
	// associated with the connection's destination address. Direct connections to the socket without
	// using “TPROXY“ cannot be distinguished from connections redirected using “TPROXY“ and are
	// therefore treated as if they were redirected.
	// When this flag is set to false, the listener's socket is explicitly reset as non-transparent.
	// Setting this flag requires Envoy to run with the “CAP_NET_ADMIN“ capability.
	// When this flag is not set (default), the socket is not modified, i.e. the transparent option
	// is neither set nor reset.
	Transparent *wrapperspb.BoolValue `protobuf:"bytes,10,opt,name=transparent,proto3" json:"transparent,omitempty"`
	// Whether the listener should set the “IP_FREEBIND“ socket option. When this
	// flag is set to true, listeners can be bound to an IP address that is not
	// configured on the system running Envoy. When this flag is set to false, the
	// option “IP_FREEBIND“ is disabled on the socket. When this flag is not set
	// (default), the socket is not modified, i.e. the option is neither enabled
	// nor disabled.
	Freebind *wrapperspb.BoolValue `protobuf:"bytes,11,opt,name=freebind,proto3" json:"freebind,omitempty"`
	// Additional socket options that may not be present in Envoy source code or
	// precompiled binaries.
	// It is not allowed to update the socket options for any existing address if
	// :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
	// is “false“ to avoid the conflict when creating new sockets for the listener.
	SocketOptions []*v3.SocketOption `protobuf:"bytes,13,rep,name=socket_options,json=socketOptions,proto3" json:"socket_options,omitempty"`
	// Whether the listener should accept TCP Fast Open (TFO) connections.
	// When this flag is set to a value greater than 0, the option TCP_FASTOPEN is enabled on
	// the socket, with a queue length of the specified size
	// (see `details in RFC7413 <https://tools.ietf.org/html/rfc7413#section-5.1>`_).
	// When this flag is set to 0, the option TCP_FASTOPEN is disabled on the socket.
	// When this flag is not set (default), the socket is not modified,
	// i.e. the option is neither enabled nor disabled.
	//
	// On Linux, the net.ipv4.tcp_fastopen kernel parameter must include flag 0x2 to enable
	// TCP_FASTOPEN.
	// See `ip-sysctl.txt <https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt>`_.
	//
	// On macOS, only values of 0, 1, and unset are valid; other values may result in an error.
	// To set the queue length on macOS, set the net.inet.tcp.fastopen_backlog kernel parameter.
	TcpFastOpenQueueLength *wrapperspb.UInt32Value `` /* 134-byte string literal not displayed */
	// Specifies the intended direction of the traffic relative to the local Envoy.
	// This property is required on Windows for listeners using the original destination filter,
	// see :ref:`Original Destination <config_listener_filters_original_dst>`.
	TrafficDirection v3.TrafficDirection `` /* 154-byte string literal not displayed */
	// If the protocol in the listener socket address in :ref:`protocol
	// <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
	// <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies UDP
	// listener specific configuration.
	UdpListenerConfig *UdpListenerConfig `protobuf:"bytes,18,opt,name=udp_listener_config,json=udpListenerConfig,proto3" json:"udp_listener_config,omitempty"`
	// Used to represent an API listener, which is used in non-proxy clients. The type of API
	// exposed to the non-proxy application depends on the type of API listener.
	// When this field is set, no other field except for :ref:`name<envoy_v3_api_field_config.listener.v3.Listener.name>`
	// should be set.
	//
	// .. note::
	//
	//	Currently only one ApiListener can be installed; and it can only be done via bootstrap config,
	//	not LDS.
	//
	// [#next-major-version: In the v3 API, instead of this messy approach where the socket
	// listener fields are directly in the top-level Listener message and the API listener types
	// are in the ApiListener message, the socket listener messages should be in their own message,
	// and the top-level Listener should essentially be a oneof that selects between the
	// socket listener and the various types of API listener. That way, a given Listener message
	// can structurally only contain the fields of the relevant type.]
	ApiListener *ApiListener `protobuf:"bytes,19,opt,name=api_listener,json=apiListener,proto3" json:"api_listener,omitempty"`
	// The listener's connection balancer configuration, currently only applicable to TCP listeners.
	// If no configuration is specified, Envoy will not attempt to balance active connections between
	// worker threads.
	//
	// In the scenario that the listener X redirects all the connections to the listeners Y1 and Y2
	// by setting :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>` in X
	// and :ref:`bind_to_port <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>` to false in Y1 and Y2,
	// it is recommended to disable the balance config in listener X to avoid the cost of balancing, and
	// enable the balance config in Y1 and Y2 to balance the connections among the workers.
	ConnectionBalanceConfig *Listener_ConnectionBalanceConfig `` /* 133-byte string literal not displayed */
	// Deprecated. Use “enable_reuse_port“ instead.
	//
	// Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.
	ReusePort bool `protobuf:"varint,21,opt,name=reuse_port,json=reusePort,proto3" json:"reuse_port,omitempty"`
	// When this flag is set to true, listeners set the “SO_REUSEPORT“ socket option and
	// create one socket for each worker thread. This makes inbound connections
	// distribute among worker threads roughly evenly in cases where there are a high number
	// of connections. When this flag is set to false, all worker threads share one socket. This field
	// defaults to true. The change of field will be rejected during an listener update when the
	// runtime flag “envoy.reloadable_features.enable_update_listener_socket_options“ is enabled.
	// Otherwise, the update of this field will be ignored quietly.
	//
	// .. attention::
	//
	//	Although this field defaults to true, it has different behavior on different platforms. See
	//	the following text for more information.
	//
	//   - On Linux, reuse_port is respected for both TCP and UDP listeners. It also works correctly
	//     with hot restart.
	//   - On macOS, reuse_port for TCP does not do what it does on Linux. Instead of load balancing,
	//     the last socket wins and receives all connections/packets. For TCP, reuse_port is force
	//     disabled and the user is warned. For UDP, it is enabled, but only one worker will receive
	//     packets. For QUIC/H3, SW routing will send packets to other workers. For "raw" UDP, only
	//     a single worker will currently receive packets.
	//   - On Windows, reuse_port for TCP has undefined behavior. It is force disabled and the user
	//     is warned similar to macOS. It is left enabled for UDP with undefined behavior currently.
	EnableReusePort *wrapperspb.BoolValue `protobuf:"bytes,29,opt,name=enable_reuse_port,json=enableReusePort,proto3" json:"enable_reuse_port,omitempty"`
	// Configuration for :ref:`access logs <arch_overview_access_logs>`
	// emitted by this listener.
	AccessLog []*v33.AccessLog `protobuf:"bytes,22,rep,name=access_log,json=accessLog,proto3" json:"access_log,omitempty"`
	// The maximum length a tcp listener's pending connections queue can grow to. If no value is
	// provided net.core.somaxconn will be used on Linux and 128 otherwise.
	TcpBacklogSize *wrapperspb.UInt32Value `protobuf:"bytes,24,opt,name=tcp_backlog_size,json=tcpBacklogSize,proto3" json:"tcp_backlog_size,omitempty"`
	// The maximum number of connections to accept from the kernel per socket
	// event. Envoy may decide to close these connections after accepting them
	// from the kernel e.g. due to load shedding, or other policies.
	// If there are more than max_connections_to_accept_per_socket_event
	// connections pending accept, connections over this threshold will be
	// accepted in later event loop iterations.
	// If no value is provided Envoy will accept all connections pending accept
	// from the kernel.
	//
	// .. note::
	//
	//	It is recommended to lower this value for better overload management and reduced per-event cost.
	//	Setting it to 1 is a viable option with no noticeable impact on performance.
	MaxConnectionsToAcceptPerSocketEvent *wrapperspb.UInt32Value `` /* 180-byte string literal not displayed */
	// Whether the listener should bind to the port. A listener that doesn't
	// bind can only receive connections redirected from other listeners that set
	// :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>`
	// to true. Default is true.
	BindToPort *wrapperspb.BoolValue `protobuf:"bytes,26,opt,name=bind_to_port,json=bindToPort,proto3" json:"bind_to_port,omitempty"`
	// The exclusive listener type and the corresponding config.
	//
	// Types that are valid to be assigned to ListenerSpecifier:
	//
	//	*Listener_InternalListener
	ListenerSpecifier isListener_ListenerSpecifier `protobuf_oneof:"listener_specifier"`
	// Enable MPTCP (multi-path TCP) on this listener. Clients will be allowed to establish
	// MPTCP connections. Non-MPTCP clients will fall back to regular TCP.
	EnableMptcp bool `protobuf:"varint,30,opt,name=enable_mptcp,json=enableMptcp,proto3" json:"enable_mptcp,omitempty"`
	// Whether the listener should limit connections based upon the value of
	// :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`.
	IgnoreGlobalConnLimit bool `` /* 130-byte string literal not displayed */
	// Whether the listener bypasses configured overload manager actions.
	BypassOverloadManager bool `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 37]

func (*Listener) ClearAddress 

func (x *Listener) ClearAddress()

func (*Listener) ClearApiListener 

func (x *Listener) ClearApiListener()

func (*Listener) ClearBindToPort 

func (x *Listener) ClearBindToPort()

func (*Listener) ClearConnectionBalanceConfig 

func (x *Listener) ClearConnectionBalanceConfig()

func (*Listener) ClearDefaultFilterChain 

func (x *Listener) ClearDefaultFilterChain()

func (*Listener) ClearDeprecatedV1 deprecated 

func (x *Listener) ClearDeprecatedV1()

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.

func (*Listener) ClearEnableReusePort 

func (x *Listener) ClearEnableReusePort()

func (*Listener) ClearFcdsConfig 

func (x *Listener) ClearFcdsConfig()

func (*Listener) ClearFilterChainMatcher 

func (x *Listener) ClearFilterChainMatcher()

func (*Listener) ClearFreebind 

func (x *Listener) ClearFreebind()

func (*Listener) ClearInternalListener 

func (x *Listener) ClearInternalListener()

func (*Listener) ClearListenerFiltersTimeout 

func (x *Listener) ClearListenerFiltersTimeout()

func (*Listener) ClearListenerSpecifier 

func (x *Listener) ClearListenerSpecifier()

func (*Listener) ClearMaxConnectionsToAcceptPerSocketEvent 

func (x *Listener) ClearMaxConnectionsToAcceptPerSocketEvent()

func (*Listener) ClearMetadata 

func (x *Listener) ClearMetadata()

func (*Listener) ClearPerConnectionBufferLimitBytes 

func (x *Listener) ClearPerConnectionBufferLimitBytes()

func (*Listener) ClearTcpBacklogSize 

func (x *Listener) ClearTcpBacklogSize()

func (*Listener) ClearTcpFastOpenQueueLength 

func (x *Listener) ClearTcpFastOpenQueueLength()

func (*Listener) ClearTransparent 

func (x *Listener) ClearTransparent()

func (*Listener) ClearUdpListenerConfig 

func (x *Listener) ClearUdpListenerConfig()

func (*Listener) ClearUseOriginalDst 

func (x *Listener) ClearUseOriginalDst()

func (*Listener) GetAccessLog 

func (x *Listener) GetAccessLog() []*v33.AccessLog

func (*Listener) GetAdditionalAddresses 

func (x *Listener) GetAdditionalAddresses() []*AdditionalAddress

func (*Listener) GetAddress 

func (x *Listener) GetAddress() *v3.Address

func (*Listener) GetApiListener 

func (x *Listener) GetApiListener() *ApiListener

func (*Listener) GetBindToPort 

func (x *Listener) GetBindToPort() *wrapperspb.BoolValue

func (*Listener) GetBypassOverloadManager 

func (x *Listener) GetBypassOverloadManager() bool

func (*Listener) GetConnectionBalanceConfig 

func (x *Listener) GetConnectionBalanceConfig() *Listener_ConnectionBalanceConfig

func (*Listener) GetContinueOnListenerFiltersTimeout 

func (x *Listener) GetContinueOnListenerFiltersTimeout() bool

func (*Listener) GetDefaultFilterChain 

func (x *Listener) GetDefaultFilterChain() *FilterChain

func (*Listener) GetDeprecatedV1 deprecated 

func (x *Listener) GetDeprecatedV1() *Listener_DeprecatedV1

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.

func (*Listener) GetDrainType 

func (x *Listener) GetDrainType() Listener_DrainType

func (*Listener) GetEnableMptcp 

func (x *Listener) GetEnableMptcp() bool

func (*Listener) GetEnableReusePort 

func (x *Listener) GetEnableReusePort() *wrapperspb.BoolValue

func (*Listener) GetFcdsConfig 

func (x *Listener) GetFcdsConfig() *Listener_FcdsConfig

func (*Listener) GetFilterChainMatcher 

func (x *Listener) GetFilterChainMatcher() *v32.Matcher

func (*Listener) GetFilterChains 

func (x *Listener) GetFilterChains() []*FilterChain

func (*Listener) GetFreebind 

func (x *Listener) GetFreebind() *wrapperspb.BoolValue

func (*Listener) GetIgnoreGlobalConnLimit 

func (x *Listener) GetIgnoreGlobalConnLimit() bool

func (*Listener) GetInternalListener 

func (x *Listener) GetInternalListener() *Listener_InternalListenerConfig

func (*Listener) GetListenerFilters 

func (x *Listener) GetListenerFilters() []*ListenerFilter

func (*Listener) GetListenerFiltersTimeout 

func (x *Listener) GetListenerFiltersTimeout() *durationpb.Duration

func (*Listener) GetListenerSpecifier 

func (x *Listener) GetListenerSpecifier() isListener_ListenerSpecifier

func (*Listener) GetMaxConnectionsToAcceptPerSocketEvent 

func (x *Listener) GetMaxConnectionsToAcceptPerSocketEvent() *wrapperspb.UInt32Value

func (*Listener) GetMetadata 

func (x *Listener) GetMetadata() *v3.Metadata

func (*Listener) GetName 

func (x *Listener) GetName() string

func (*Listener) GetPerConnectionBufferLimitBytes 

func (x *Listener) GetPerConnectionBufferLimitBytes() *wrapperspb.UInt32Value

func (*Listener) GetReusePort deprecated 

func (x *Listener) GetReusePort() bool

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.

func (*Listener) GetSocketOptions 

func (x *Listener) GetSocketOptions() []*v3.SocketOption

func (*Listener) GetStatPrefix 

func (x *Listener) GetStatPrefix() string

func (*Listener) GetTcpBacklogSize 

func (x *Listener) GetTcpBacklogSize() *wrapperspb.UInt32Value

func (*Listener) GetTcpFastOpenQueueLength 

func (x *Listener) GetTcpFastOpenQueueLength() *wrapperspb.UInt32Value

func (*Listener) GetTrafficDirection 

func (x *Listener) GetTrafficDirection() v3.TrafficDirection

func (*Listener) GetTransparent 

func (x *Listener) GetTransparent() *wrapperspb.BoolValue

func (*Listener) GetUdpListenerConfig 

func (x *Listener) GetUdpListenerConfig() *UdpListenerConfig

func (*Listener) GetUseOriginalDst 

func (x *Listener) GetUseOriginalDst() *wrapperspb.BoolValue

func (*Listener) HasAddress 

func (x *Listener) HasAddress() bool

func (*Listener) HasApiListener 

func (x *Listener) HasApiListener() bool

func (*Listener) HasBindToPort 

func (x *Listener) HasBindToPort() bool

func (*Listener) HasConnectionBalanceConfig 

func (x *Listener) HasConnectionBalanceConfig() bool

func (*Listener) HasDefaultFilterChain 

func (x *Listener) HasDefaultFilterChain() bool

func (*Listener) HasDeprecatedV1 deprecated 

func (x *Listener) HasDeprecatedV1() bool

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.

func (*Listener) HasEnableReusePort 

func (x *Listener) HasEnableReusePort() bool

func (*Listener) HasFcdsConfig 

func (x *Listener) HasFcdsConfig() bool

func (*Listener) HasFilterChainMatcher 

func (x *Listener) HasFilterChainMatcher() bool

func (*Listener) HasFreebind 

func (x *Listener) HasFreebind() bool

func (*Listener) HasInternalListener 

func (x *Listener) HasInternalListener() bool

func (*Listener) HasListenerFiltersTimeout 

func (x *Listener) HasListenerFiltersTimeout() bool

func (*Listener) HasListenerSpecifier 

func (x *Listener) HasListenerSpecifier() bool

func (*Listener) HasMaxConnectionsToAcceptPerSocketEvent 

func (x *Listener) HasMaxConnectionsToAcceptPerSocketEvent() bool

func (*Listener) HasMetadata 

func (x *Listener) HasMetadata() bool

func (*Listener) HasPerConnectionBufferLimitBytes 

func (x *Listener) HasPerConnectionBufferLimitBytes() bool

func (*Listener) HasTcpBacklogSize 

func (x *Listener) HasTcpBacklogSize() bool

func (*Listener) HasTcpFastOpenQueueLength 

func (x *Listener) HasTcpFastOpenQueueLength() bool

func (*Listener) HasTransparent 

func (x *Listener) HasTransparent() bool

func (*Listener) HasUdpListenerConfig 

func (x *Listener) HasUdpListenerConfig() bool

func (*Listener) HasUseOriginalDst 

func (x *Listener) HasUseOriginalDst() bool

func (*Listener) ProtoMessage 

func (*Listener) ProtoMessage()

func (*Listener) ProtoReflect 

func (x *Listener) ProtoReflect() protoreflect.Message

func (*Listener) Reset 

func (x *Listener) Reset()

func (*Listener) SetAccessLog 

func (x *Listener) SetAccessLog(v []*v33.AccessLog)

func (*Listener) SetAdditionalAddresses 

func (x *Listener) SetAdditionalAddresses(v []*AdditionalAddress)

func (*Listener) SetAddress 

func (x *Listener) SetAddress(v *v3.Address)

func (*Listener) SetApiListener 

func (x *Listener) SetApiListener(v *ApiListener)

func (*Listener) SetBindToPort 

func (x *Listener) SetBindToPort(v *wrapperspb.BoolValue)

func (*Listener) SetBypassOverloadManager 

func (x *Listener) SetBypassOverloadManager(v bool)

func (*Listener) SetConnectionBalanceConfig 

func (x *Listener) SetConnectionBalanceConfig(v *Listener_ConnectionBalanceConfig)

func (*Listener) SetContinueOnListenerFiltersTimeout 

func (x *Listener) SetContinueOnListenerFiltersTimeout(v bool)

func (*Listener) SetDefaultFilterChain 

func (x *Listener) SetDefaultFilterChain(v *FilterChain)

func (*Listener) SetDeprecatedV1 deprecated 

func (x *Listener) SetDeprecatedV1(v *Listener_DeprecatedV1)

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.

func (*Listener) SetDrainType 

func (x *Listener) SetDrainType(v Listener_DrainType)

func (*Listener) SetEnableMptcp 

func (x *Listener) SetEnableMptcp(v bool)

func (*Listener) SetEnableReusePort 

func (x *Listener) SetEnableReusePort(v *wrapperspb.BoolValue)

func (*Listener) SetFcdsConfig 

func (x *Listener) SetFcdsConfig(v *Listener_FcdsConfig)

func (*Listener) SetFilterChainMatcher 

func (x *Listener) SetFilterChainMatcher(v *v32.Matcher)

func (*Listener) SetFilterChains 

func (x *Listener) SetFilterChains(v []*FilterChain)

func (*Listener) SetFreebind 

func (x *Listener) SetFreebind(v *wrapperspb.BoolValue)

func (*Listener) SetIgnoreGlobalConnLimit 

func (x *Listener) SetIgnoreGlobalConnLimit(v bool)

func (*Listener) SetInternalListener 

func (x *Listener) SetInternalListener(v *Listener_InternalListenerConfig)

func (*Listener) SetListenerFilters 

func (x *Listener) SetListenerFilters(v []*ListenerFilter)

func (*Listener) SetListenerFiltersTimeout 

func (x *Listener) SetListenerFiltersTimeout(v *durationpb.Duration)

func (*Listener) SetMaxConnectionsToAcceptPerSocketEvent 

func (x *Listener) SetMaxConnectionsToAcceptPerSocketEvent(v *wrapperspb.UInt32Value)

func (*Listener) SetMetadata 

func (x *Listener) SetMetadata(v *v3.Metadata)

func (*Listener) SetName 

func (x *Listener) SetName(v string)

func (*Listener) SetPerConnectionBufferLimitBytes 

func (x *Listener) SetPerConnectionBufferLimitBytes(v *wrapperspb.UInt32Value)

func (*Listener) SetReusePort deprecated 

func (x *Listener) SetReusePort(v bool)

Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.

func (*Listener) SetSocketOptions 

func (x *Listener) SetSocketOptions(v []*v3.SocketOption)

func (*Listener) SetStatPrefix 

func (x *Listener) SetStatPrefix(v string)

func (*Listener) SetTcpBacklogSize 

func (x *Listener) SetTcpBacklogSize(v *wrapperspb.UInt32Value)

func (*Listener) SetTcpFastOpenQueueLength 

func (x *Listener) SetTcpFastOpenQueueLength(v *wrapperspb.UInt32Value)

func (*Listener) SetTrafficDirection 

func (x *Listener) SetTrafficDirection(v v3.TrafficDirection)

func (*Listener) SetTransparent 

func (x *Listener) SetTransparent(v *wrapperspb.BoolValue)

func (*Listener) SetUdpListenerConfig 

func (x *Listener) SetUdpListenerConfig(v *UdpListenerConfig)

func (*Listener) SetUseOriginalDst 

func (x *Listener) SetUseOriginalDst(v *wrapperspb.BoolValue)

func (*Listener) String 

func (x *Listener) String() string

func (*Listener) WhichListenerSpecifier 

func (x *Listener) WhichListenerSpecifier() case_Listener_ListenerSpecifier

type ListenerCollection 

type ListenerCollection struct {
	Entries []*v31.CollectionEntry `protobuf:"bytes,1,rep,name=entries,proto3" json:"entries,omitempty"`
	// contains filtered or unexported fields
}

Listener list collections. Entries are “Listener“ resources or references. [#not-implemented-hide:]

func (*ListenerCollection) GetEntries 

func (x *ListenerCollection) GetEntries() []*v31.CollectionEntry

func (*ListenerCollection) ProtoMessage 

func (*ListenerCollection) ProtoMessage()

func (*ListenerCollection) ProtoReflect 

func (x *ListenerCollection) ProtoReflect() protoreflect.Message

func (*ListenerCollection) Reset 

func (x *ListenerCollection) Reset()

func (*ListenerCollection) SetEntries 

func (x *ListenerCollection) SetEntries(v []*v31.CollectionEntry)

func (*ListenerCollection) String 

func (x *ListenerCollection) String() string

type ListenerCollection_builder 

type ListenerCollection_builder struct {
	Entries []*v31.CollectionEntry
	// contains filtered or unexported fields
}

func (ListenerCollection_builder) Build 

func (b0 ListenerCollection_builder) Build() *ListenerCollection

type ListenerFilter 

type ListenerFilter struct {

	// The name of the filter configuration.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Types that are valid to be assigned to ConfigType:
	//
	//	*ListenerFilter_TypedConfig
	//	*ListenerFilter_ConfigDiscovery
	ConfigType isListenerFilter_ConfigType `protobuf_oneof:"config_type"`
	// Optional match predicate used to disable the filter. The filter is enabled when this field is empty.
	// See :ref:`ListenerFilterChainMatchPredicate <envoy_v3_api_msg_config.listener.v3.ListenerFilterChainMatchPredicate>`
	// for further examples.
	FilterDisabled *ListenerFilterChainMatchPredicate `protobuf:"bytes,4,opt,name=filter_disabled,json=filterDisabled,proto3" json:"filter_disabled,omitempty"`
	// contains filtered or unexported fields
}

[#next-free-field: 6]

func (*ListenerFilter) ClearConfigDiscovery 

func (x *ListenerFilter) ClearConfigDiscovery()

func (*ListenerFilter) ClearConfigType 

func (x *ListenerFilter) ClearConfigType()

func (*ListenerFilter) ClearFilterDisabled 

func (x *ListenerFilter) ClearFilterDisabled()

func (*ListenerFilter) ClearTypedConfig 

func (x *ListenerFilter) ClearTypedConfig()

func (*ListenerFilter) GetConfigDiscovery 

func (x *ListenerFilter) GetConfigDiscovery() *v3.ExtensionConfigSource

func (*ListenerFilter) GetConfigType 

func (x *ListenerFilter) GetConfigType() isListenerFilter_ConfigType

func (*ListenerFilter) GetFilterDisabled 

func (x *ListenerFilter) GetFilterDisabled() *ListenerFilterChainMatchPredicate

func (*ListenerFilter) GetName 

func (x *ListenerFilter) GetName() string

func (*ListenerFilter) GetTypedConfig 

func (x *ListenerFilter) GetTypedConfig() *anypb.Any

func (*ListenerFilter) HasConfigDiscovery 

func (x *ListenerFilter) HasConfigDiscovery() bool

func (*ListenerFilter) HasConfigType 

func (x *ListenerFilter) HasConfigType() bool

func (*ListenerFilter) HasFilterDisabled 

func (x *ListenerFilter) HasFilterDisabled() bool

func (*ListenerFilter) HasTypedConfig 

func (x *ListenerFilter) HasTypedConfig() bool

func (*ListenerFilter) ProtoMessage 

func (*ListenerFilter) ProtoMessage()

func (*ListenerFilter) ProtoReflect 

func (x *ListenerFilter) ProtoReflect() protoreflect.Message

func (*ListenerFilter) Reset 

func (x *ListenerFilter) Reset()

func (*ListenerFilter) SetConfigDiscovery 

func (x *ListenerFilter) SetConfigDiscovery(v *v3.ExtensionConfigSource)

func (*ListenerFilter) SetFilterDisabled 

func (x *ListenerFilter) SetFilterDisabled(v *ListenerFilterChainMatchPredicate)

func (*ListenerFilter) SetName 

func (x *ListenerFilter) SetName(v string)

func (*ListenerFilter) SetTypedConfig 

func (x *ListenerFilter) SetTypedConfig(v *anypb.Any)

func (*ListenerFilter) String 

func (x *ListenerFilter) String() string

func (*ListenerFilter) WhichConfigType 

func (x *ListenerFilter) WhichConfigType() case_ListenerFilter_ConfigType

type ListenerFilterChainMatchPredicate 

type ListenerFilterChainMatchPredicate struct {

	// Types that are valid to be assigned to Rule:
	//
	//	*ListenerFilterChainMatchPredicate_OrMatch
	//	*ListenerFilterChainMatchPredicate_AndMatch
	//	*ListenerFilterChainMatchPredicate_NotMatch
	//	*ListenerFilterChainMatchPredicate_AnyMatch
	//	*ListenerFilterChainMatchPredicate_DestinationPortRange
	Rule isListenerFilterChainMatchPredicate_Rule `protobuf_oneof:"rule"`
	// contains filtered or unexported fields
}

Listener filter chain match configuration. This is a recursive structure which allows complex nested match configurations to be built using various logical operators.

Examples:

* Matches if the destination port is 3306.

.. code-block:: yaml 

destination_port_range:
 start: 3306
 end: 3307

* Matches if the destination port is 3306 or 15000.

.. code-block:: yaml 

or_match:
  rules:
    - destination_port_range:
        start: 3306
        end: 3307
    - destination_port_range:
        start: 15000
        end: 15001

[#next-free-field: 6]

func (*ListenerFilterChainMatchPredicate) ClearAndMatch 

func (x *ListenerFilterChainMatchPredicate) ClearAndMatch()

func (*ListenerFilterChainMatchPredicate) ClearAnyMatch 

func (x *ListenerFilterChainMatchPredicate) ClearAnyMatch()

func (*ListenerFilterChainMatchPredicate) ClearDestinationPortRange 

func (x *ListenerFilterChainMatchPredicate) ClearDestinationPortRange()

func (*ListenerFilterChainMatchPredicate) ClearNotMatch 

func (x *ListenerFilterChainMatchPredicate) ClearNotMatch()

func (*ListenerFilterChainMatchPredicate) ClearOrMatch 

func (x *ListenerFilterChainMatchPredicate) ClearOrMatch()

func (*ListenerFilterChainMatchPredicate) ClearRule 

func (x *ListenerFilterChainMatchPredicate) ClearRule()

func (*ListenerFilterChainMatchPredicate) GetAndMatch 

func (x *ListenerFilterChainMatchPredicate) GetAndMatch() *ListenerFilterChainMatchPredicate_MatchSet

func (*ListenerFilterChainMatchPredicate) GetAnyMatch 

func (x *ListenerFilterChainMatchPredicate) GetAnyMatch() bool

func (*ListenerFilterChainMatchPredicate) GetDestinationPortRange 

func (x *ListenerFilterChainMatchPredicate) GetDestinationPortRange() *v31.Int32Range

func (*ListenerFilterChainMatchPredicate) GetNotMatch 

func (x *ListenerFilterChainMatchPredicate) GetNotMatch() *ListenerFilterChainMatchPredicate

func (*ListenerFilterChainMatchPredicate) GetOrMatch 

func (x *ListenerFilterChainMatchPredicate) GetOrMatch() *ListenerFilterChainMatchPredicate_MatchSet

func (*ListenerFilterChainMatchPredicate) GetRule 

func (x *ListenerFilterChainMatchPredicate) GetRule() isListenerFilterChainMatchPredicate_Rule

func (*ListenerFilterChainMatchPredicate) HasAndMatch 

func (x *ListenerFilterChainMatchPredicate) HasAndMatch() bool

func (*ListenerFilterChainMatchPredicate) HasAnyMatch 

func (x *ListenerFilterChainMatchPredicate) HasAnyMatch() bool

func (*ListenerFilterChainMatchPredicate) HasDestinationPortRange 

func (x *ListenerFilterChainMatchPredicate) HasDestinationPortRange() bool

func (*ListenerFilterChainMatchPredicate) HasNotMatch 

func (x *ListenerFilterChainMatchPredicate) HasNotMatch() bool

func (*ListenerFilterChainMatchPredicate) HasOrMatch 

func (x *ListenerFilterChainMatchPredicate) HasOrMatch() bool

func (*ListenerFilterChainMatchPredicate) HasRule 

func (x *ListenerFilterChainMatchPredicate) HasRule() bool

func (*ListenerFilterChainMatchPredicate) ProtoMessage 

func (*ListenerFilterChainMatchPredicate) ProtoMessage()

func (*ListenerFilterChainMatchPredicate) ProtoReflect 

func (x *ListenerFilterChainMatchPredicate) ProtoReflect() protoreflect.Message

func (*ListenerFilterChainMatchPredicate) Reset 

func (x *ListenerFilterChainMatchPredicate) Reset()

func (*ListenerFilterChainMatchPredicate) SetAndMatch 

func (x *ListenerFilterChainMatchPredicate) SetAndMatch(v *ListenerFilterChainMatchPredicate_MatchSet)

func (*ListenerFilterChainMatchPredicate) SetAnyMatch 

func (x *ListenerFilterChainMatchPredicate) SetAnyMatch(v bool)

func (*ListenerFilterChainMatchPredicate) SetDestinationPortRange 

func (x *ListenerFilterChainMatchPredicate) SetDestinationPortRange(v *v31.Int32Range)

func (*ListenerFilterChainMatchPredicate) SetNotMatch 

func (x *ListenerFilterChainMatchPredicate) SetNotMatch(v *ListenerFilterChainMatchPredicate)

func (*ListenerFilterChainMatchPredicate) SetOrMatch 

func (x *ListenerFilterChainMatchPredicate) SetOrMatch(v *ListenerFilterChainMatchPredicate_MatchSet)

func (*ListenerFilterChainMatchPredicate) String 

func (x *ListenerFilterChainMatchPredicate) String() string

func (*ListenerFilterChainMatchPredicate) WhichRule 

func (x *ListenerFilterChainMatchPredicate) WhichRule() case_ListenerFilterChainMatchPredicate_Rule

type ListenerFilterChainMatchPredicate_AndMatch 

type ListenerFilterChainMatchPredicate_AndMatch struct {
	// A set that describes a logical AND. If all members of the set match, the match configuration
	// matches.
	AndMatch *ListenerFilterChainMatchPredicate_MatchSet `protobuf:"bytes,2,opt,name=and_match,json=andMatch,proto3,oneof"`
}

type ListenerFilterChainMatchPredicate_AnyMatch 

type ListenerFilterChainMatchPredicate_AnyMatch struct {
	// The match configuration will always match.
	AnyMatch bool `protobuf:"varint,4,opt,name=any_match,json=anyMatch,proto3,oneof"`
}

type ListenerFilterChainMatchPredicate_DestinationPortRange 

type ListenerFilterChainMatchPredicate_DestinationPortRange struct {
	// Match destination port. Particularly, the match evaluation must use the recovered local port if
	// the owning listener filter is after :ref:`an original_dst listener filter <config_listener_filters_original_dst>`.
	DestinationPortRange *v31.Int32Range `protobuf:"bytes,5,opt,name=destination_port_range,json=destinationPortRange,proto3,oneof"`
}

type ListenerFilterChainMatchPredicate_MatchSet 

type ListenerFilterChainMatchPredicate_MatchSet struct {

	// The list of rules that make up the set.
	Rules []*ListenerFilterChainMatchPredicate `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
	// contains filtered or unexported fields
}

A set of match configurations used for logical operations.

func (*ListenerFilterChainMatchPredicate_MatchSet) GetRules 

func (x *ListenerFilterChainMatchPredicate_MatchSet) GetRules() []*ListenerFilterChainMatchPredicate

func (*ListenerFilterChainMatchPredicate_MatchSet) ProtoMessage 

func (*ListenerFilterChainMatchPredicate_MatchSet) ProtoMessage()

func (*ListenerFilterChainMatchPredicate_MatchSet) ProtoReflect 

func (x *ListenerFilterChainMatchPredicate_MatchSet) ProtoReflect() protoreflect.Message

func (*ListenerFilterChainMatchPredicate_MatchSet) Reset 

func (x *ListenerFilterChainMatchPredicate_MatchSet) Reset()

func (*ListenerFilterChainMatchPredicate_MatchSet) SetRules 

func (x *ListenerFilterChainMatchPredicate_MatchSet) SetRules(v []*ListenerFilterChainMatchPredicate)

func (*ListenerFilterChainMatchPredicate_MatchSet) String 

func (x *ListenerFilterChainMatchPredicate_MatchSet) String() string

type ListenerFilterChainMatchPredicate_MatchSet_builder 

type ListenerFilterChainMatchPredicate_MatchSet_builder struct {

	// The list of rules that make up the set.
	Rules []*ListenerFilterChainMatchPredicate
	// contains filtered or unexported fields
}

func (ListenerFilterChainMatchPredicate_MatchSet_builder) Build 

func (b0 ListenerFilterChainMatchPredicate_MatchSet_builder) Build() *ListenerFilterChainMatchPredicate_MatchSet

type ListenerFilterChainMatchPredicate_NotMatch 

type ListenerFilterChainMatchPredicate_NotMatch struct {
	// A negation match. The match configuration will match if the negated match condition matches.
	NotMatch *ListenerFilterChainMatchPredicate `protobuf:"bytes,3,opt,name=not_match,json=notMatch,proto3,oneof"`
}

type ListenerFilterChainMatchPredicate_OrMatch 

type ListenerFilterChainMatchPredicate_OrMatch struct {
	// A set that describes a logical OR. If any member of the set matches, the match configuration
	// matches.
	OrMatch *ListenerFilterChainMatchPredicate_MatchSet `protobuf:"bytes,1,opt,name=or_match,json=orMatch,proto3,oneof"`
}

type ListenerFilterChainMatchPredicate_builder 

type ListenerFilterChainMatchPredicate_builder struct {

	// Fields of oneof Rule:
	// A set that describes a logical OR. If any member of the set matches, the match configuration
	// matches.
	OrMatch *ListenerFilterChainMatchPredicate_MatchSet
	// A set that describes a logical AND. If all members of the set match, the match configuration
	// matches.
	AndMatch *ListenerFilterChainMatchPredicate_MatchSet
	// A negation match. The match configuration will match if the negated match condition matches.
	NotMatch *ListenerFilterChainMatchPredicate
	// The match configuration will always match.
	AnyMatch *bool
	// Match destination port. Particularly, the match evaluation must use the recovered local port if
	// the owning listener filter is after :ref:`an original_dst listener filter <config_listener_filters_original_dst>`.
	DestinationPortRange *v31.Int32Range
	// contains filtered or unexported fields
}

func (ListenerFilterChainMatchPredicate_builder) Build 

func (b0 ListenerFilterChainMatchPredicate_builder) Build() *ListenerFilterChainMatchPredicate

type ListenerFilter_ConfigDiscovery 

type ListenerFilter_ConfigDiscovery struct {
	// Configuration source specifier for an extension configuration discovery
	// service. In case of a failure and without the default configuration, the
	// listener closes the connections.
	ConfigDiscovery *v3.ExtensionConfigSource `protobuf:"bytes,5,opt,name=config_discovery,json=configDiscovery,proto3,oneof"`
}

type ListenerFilter_TypedConfig 

type ListenerFilter_TypedConfig struct {
	// Filter specific configuration which depends on the filter being
	// instantiated. See the supported filters for further documentation.
	// [#extension-category: envoy.filters.listener,envoy.filters.udp_listener]
	TypedConfig *anypb.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}

type ListenerFilter_builder 

type ListenerFilter_builder struct {

	// The name of the filter configuration.
	Name string
	// Fields of oneof ConfigType:
	// Filter specific configuration which depends on the filter being
	// instantiated. See the supported filters for further documentation.
	// [#extension-category: envoy.filters.listener,envoy.filters.udp_listener]
	TypedConfig *anypb.Any
	// Configuration source specifier for an extension configuration discovery
	// service. In case of a failure and without the default configuration, the
	// listener closes the connections.
	ConfigDiscovery *v3.ExtensionConfigSource
	// -- end of ConfigType
	// Optional match predicate used to disable the filter. The filter is enabled when this field is empty.
	// See :ref:`ListenerFilterChainMatchPredicate <envoy_v3_api_msg_config.listener.v3.ListenerFilterChainMatchPredicate>`
	// for further examples.
	FilterDisabled *ListenerFilterChainMatchPredicate
	// contains filtered or unexported fields
}

func (ListenerFilter_builder) Build 

func (b0 ListenerFilter_builder) Build() *ListenerFilter

type ListenerManager 

type ListenerManager struct {
	// contains filtered or unexported fields
}

A placeholder proto so that users can explicitly configure the standard Listener Manager via the bootstrap's :ref:`listener_manager <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.listener_manager>`. [#not-implemented-hide:]

func (*ListenerManager) ProtoMessage 

func (*ListenerManager) ProtoMessage()

func (*ListenerManager) ProtoReflect 

func (x *ListenerManager) ProtoReflect() protoreflect.Message

func (*ListenerManager) Reset 

func (x *ListenerManager) Reset()

func (*ListenerManager) String 

func (x *ListenerManager) String() string

type ListenerManager_builder 

type ListenerManager_builder struct {
	// contains filtered or unexported fields
}

func (ListenerManager_builder) Build 

func (b0 ListenerManager_builder) Build() *ListenerManager

type Listener_ConnectionBalanceConfig 

type Listener_ConnectionBalanceConfig struct {

	// Types that are valid to be assigned to BalanceType:
	//
	//	*Listener_ConnectionBalanceConfig_ExactBalance_
	//	*Listener_ConnectionBalanceConfig_ExtendBalance
	BalanceType isListener_ConnectionBalanceConfig_BalanceType `protobuf_oneof:"balance_type"`
	// contains filtered or unexported fields
}

Configuration for listener connection balancing.

func (*Listener_ConnectionBalanceConfig) ClearBalanceType 

func (x *Listener_ConnectionBalanceConfig) ClearBalanceType()

func (*Listener_ConnectionBalanceConfig) ClearExactBalance 

func (x *Listener_ConnectionBalanceConfig) ClearExactBalance()

func (*Listener_ConnectionBalanceConfig) ClearExtendBalance 

func (x *Listener_ConnectionBalanceConfig) ClearExtendBalance()

func (*Listener_ConnectionBalanceConfig) GetBalanceType 

func (x *Listener_ConnectionBalanceConfig) GetBalanceType() isListener_ConnectionBalanceConfig_BalanceType

func (*Listener_ConnectionBalanceConfig) GetExactBalance 

func (x *Listener_ConnectionBalanceConfig) GetExactBalance() *Listener_ConnectionBalanceConfig_ExactBalance

func (*Listener_ConnectionBalanceConfig) GetExtendBalance 

func (x *Listener_ConnectionBalanceConfig) GetExtendBalance() *v3.TypedExtensionConfig

func (*Listener_ConnectionBalanceConfig) HasBalanceType 

func (x *Listener_ConnectionBalanceConfig) HasBalanceType() bool

func (*Listener_ConnectionBalanceConfig) HasExactBalance 

func (x *Listener_ConnectionBalanceConfig) HasExactBalance() bool

func (*Listener_ConnectionBalanceConfig) HasExtendBalance 

func (x *Listener_ConnectionBalanceConfig) HasExtendBalance() bool

func (*Listener_ConnectionBalanceConfig) ProtoMessage 

func (*Listener_ConnectionBalanceConfig) ProtoMessage()

func (*Listener_ConnectionBalanceConfig) ProtoReflect 

func (x *Listener_ConnectionBalanceConfig) ProtoReflect() protoreflect.Message

func (*Listener_ConnectionBalanceConfig) Reset 

func (x *Listener_ConnectionBalanceConfig) Reset()

func (*Listener_ConnectionBalanceConfig) SetExactBalance 

func (x *Listener_ConnectionBalanceConfig) SetExactBalance(v *Listener_ConnectionBalanceConfig_ExactBalance)

func (*Listener_ConnectionBalanceConfig) SetExtendBalance 

func (x *Listener_ConnectionBalanceConfig) SetExtendBalance(v *v3.TypedExtensionConfig)

func (*Listener_ConnectionBalanceConfig) String 

func (x *Listener_ConnectionBalanceConfig) String() string

func (*Listener_ConnectionBalanceConfig) WhichBalanceType 

func (x *Listener_ConnectionBalanceConfig) WhichBalanceType() case_Listener_ConnectionBalanceConfig_BalanceType

type Listener_ConnectionBalanceConfig_ExactBalance 

type Listener_ConnectionBalanceConfig_ExactBalance struct {
	// contains filtered or unexported fields
}

A connection balancer implementation that does exact balancing. This means that a lock is held during balancing so that connection counts are nearly exactly balanced between worker threads. This is "nearly" exact in the sense that a connection might close in parallel thus making the counts incorrect, but this should be rectified on the next accept. This balancer sacrifices accept throughput for accuracy and should be used when there are a small number of connections that rarely cycle (e.g., service mesh gRPC egress).

func (*Listener_ConnectionBalanceConfig_ExactBalance) ProtoMessage 

func (*Listener_ConnectionBalanceConfig_ExactBalance) ProtoMessage()

func (*Listener_ConnectionBalanceConfig_ExactBalance) ProtoReflect 

func (x *Listener_ConnectionBalanceConfig_ExactBalance) ProtoReflect() protoreflect.Message

func (*Listener_ConnectionBalanceConfig_ExactBalance) Reset 

func (x *Listener_ConnectionBalanceConfig_ExactBalance) Reset()

func (*Listener_ConnectionBalanceConfig_ExactBalance) String 

func (x *Listener_ConnectionBalanceConfig_ExactBalance) String() string

type Listener_ConnectionBalanceConfig_ExactBalance_ 

type Listener_ConnectionBalanceConfig_ExactBalance_ struct {
	// If specified, the listener will use the exact connection balancer.
	ExactBalance *Listener_ConnectionBalanceConfig_ExactBalance `protobuf:"bytes,1,opt,name=exact_balance,json=exactBalance,proto3,oneof"`
}

type Listener_ConnectionBalanceConfig_ExactBalance_builder 

type Listener_ConnectionBalanceConfig_ExactBalance_builder struct {
	// contains filtered or unexported fields
}

func (Listener_ConnectionBalanceConfig_ExactBalance_builder) Build 

func (b0 Listener_ConnectionBalanceConfig_ExactBalance_builder) Build() *Listener_ConnectionBalanceConfig_ExactBalance

type Listener_ConnectionBalanceConfig_ExtendBalance 

type Listener_ConnectionBalanceConfig_ExtendBalance struct {
	// The listener will use the connection balancer according to “type_url“. If “type_url“ is invalid,
	// Envoy will not attempt to balance active connections between worker threads.
	// [#extension-category: envoy.network.connection_balance]
	ExtendBalance *v3.TypedExtensionConfig `protobuf:"bytes,2,opt,name=extend_balance,json=extendBalance,proto3,oneof"`
}

type Listener_ConnectionBalanceConfig_builder 

type Listener_ConnectionBalanceConfig_builder struct {

	// Fields of oneof BalanceType:
	// If specified, the listener will use the exact connection balancer.
	ExactBalance *Listener_ConnectionBalanceConfig_ExactBalance
	// The listener will use the connection balancer according to “type_url“. If “type_url“ is invalid,
	// Envoy will not attempt to balance active connections between worker threads.
	// [#extension-category: envoy.network.connection_balance]
	ExtendBalance *v3.TypedExtensionConfig
	// contains filtered or unexported fields
}

func (Listener_ConnectionBalanceConfig_builder) Build 

func (b0 Listener_ConnectionBalanceConfig_builder) Build() *Listener_ConnectionBalanceConfig

type Listener_DeprecatedV1 

type Listener_DeprecatedV1 struct {

	// Whether the listener should bind to the port. A listener that doesn't
	// bind can only receive connections redirected from other listeners that
	// set use_original_dst parameter to true. Default is true.
	//
	// This is deprecated. Use :ref:`Listener.bind_to_port
	// <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>`
	BindToPort *wrapperspb.BoolValue `protobuf:"bytes,1,opt,name=bind_to_port,json=bindToPort,proto3" json:"bind_to_port,omitempty"`
	// contains filtered or unexported fields
}

[#not-implemented-hide:]

func (*Listener_DeprecatedV1) ClearBindToPort 

func (x *Listener_DeprecatedV1) ClearBindToPort()

func (*Listener_DeprecatedV1) GetBindToPort 

func (x *Listener_DeprecatedV1) GetBindToPort() *wrapperspb.BoolValue

func (*Listener_DeprecatedV1) HasBindToPort 

func (x *Listener_DeprecatedV1) HasBindToPort() bool

func (*Listener_DeprecatedV1) ProtoMessage 

func (*Listener_DeprecatedV1) ProtoMessage()

func (*Listener_DeprecatedV1) ProtoReflect 

func (x *Listener_DeprecatedV1) ProtoReflect() protoreflect.Message

func (*Listener_DeprecatedV1) Reset 

func (x *Listener_DeprecatedV1) Reset()

func (*Listener_DeprecatedV1) SetBindToPort 

func (x *Listener_DeprecatedV1) SetBindToPort(v *wrapperspb.BoolValue)

func (*Listener_DeprecatedV1) String 

func (x *Listener_DeprecatedV1) String() string

type Listener_DeprecatedV1_builder 

type Listener_DeprecatedV1_builder struct {

	// Whether the listener should bind to the port. A listener that doesn't
	// bind can only receive connections redirected from other listeners that
	// set use_original_dst parameter to true. Default is true.
	//
	// This is deprecated. Use :ref:`Listener.bind_to_port
	// <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>`
	BindToPort *wrapperspb.BoolValue
	// contains filtered or unexported fields
}

func (Listener_DeprecatedV1_builder) Build 

func (b0 Listener_DeprecatedV1_builder) Build() *Listener_DeprecatedV1

type Listener_DrainType 

type Listener_DrainType int32
const (
	// Drain in response to calling /healthcheck/fail admin endpoint (along with the health check
	// filter), listener removal/modification, and hot restart.
	Listener_DEFAULT Listener_DrainType = 0
	// Drain in response to listener removal/modification and hot restart. This setting does not
	// include /healthcheck/fail. This setting may be desirable if Envoy is hosting both ingress
	// and egress listeners.
	Listener_MODIFY_ONLY Listener_DrainType = 1
)

func (Listener_DrainType) Descriptor 

func (Listener_DrainType) Descriptor() protoreflect.EnumDescriptor

func (Listener_DrainType) Enum 

func (x Listener_DrainType) Enum() *Listener_DrainType

func (Listener_DrainType) Number 

func (x Listener_DrainType) Number() protoreflect.EnumNumber

func (Listener_DrainType) String 

func (x Listener_DrainType) String() string

func (Listener_DrainType) Type 

func (Listener_DrainType) Type() protoreflect.EnumType

type Listener_FcdsConfig 

type Listener_FcdsConfig struct {

	// Optional name to present to the filter chain discovery service. This may be an arbitrary name with arbitrary
	// length. If a name is not provided, the listener's name is used. Refer to :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.name>`.
	// for details on how listener name is determined if unspecified. In addition, this may be a xdstp:// URL.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Configuration for the source of FCDS updates for this listener.
	// .. note::
	//
	//	This discovery service only supports “AGGREGATED_GRPC“ API type.
	ConfigSource *v3.ConfigSource `protobuf:"bytes,2,opt,name=config_source,json=configSource,proto3" json:"config_source,omitempty"`
	// contains filtered or unexported fields
}

Configuration for filter chains discovery. [#not-implemented-hide:]

func (*Listener_FcdsConfig) ClearConfigSource 

func (x *Listener_FcdsConfig) ClearConfigSource()

func (*Listener_FcdsConfig) GetConfigSource 

func (x *Listener_FcdsConfig) GetConfigSource() *v3.ConfigSource

func (*Listener_FcdsConfig) GetName 

func (x *Listener_FcdsConfig) GetName() string

func (*Listener_FcdsConfig) HasConfigSource 

func (x *Listener_FcdsConfig) HasConfigSource() bool

func (*Listener_FcdsConfig) ProtoMessage 

func (*Listener_FcdsConfig) ProtoMessage()

func (*Listener_FcdsConfig) ProtoReflect 

func (x *Listener_FcdsConfig) ProtoReflect() protoreflect.Message

func (*Listener_FcdsConfig) Reset 

func (x *Listener_FcdsConfig) Reset()

func (*Listener_FcdsConfig) SetConfigSource 

func (x *Listener_FcdsConfig) SetConfigSource(v *v3.ConfigSource)

func (*Listener_FcdsConfig) SetName 

func (x *Listener_FcdsConfig) SetName(v string)

func (*Listener_FcdsConfig) String 

func (x *Listener_FcdsConfig) String() string

type Listener_FcdsConfig_builder 

type Listener_FcdsConfig_builder struct {

	// Optional name to present to the filter chain discovery service. This may be an arbitrary name with arbitrary
	// length. If a name is not provided, the listener's name is used. Refer to :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.name>`.
	// for details on how listener name is determined if unspecified. In addition, this may be a xdstp:// URL.
	Name string
	// Configuration for the source of FCDS updates for this listener.
	// .. note::
	//
	//	This discovery service only supports “AGGREGATED_GRPC“ API type.
	ConfigSource *v3.ConfigSource
	// contains filtered or unexported fields
}

func (Listener_FcdsConfig_builder) Build 

func (b0 Listener_FcdsConfig_builder) Build() *Listener_FcdsConfig

type Listener_InternalListener 

type Listener_InternalListener struct {
	// Used to represent an internal listener which does not listen on OSI L4 address but can be used by the
	// :ref:`envoy cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` to create a user space connection to.
	// The internal listener acts as a TCP listener. It supports listener filters and network filter chains.
	// Upstream clusters refer to the internal listeners by their :ref:`name
	// <envoy_v3_api_field_config.listener.v3.Listener.name>`. :ref:`Address
	// <envoy_v3_api_field_config.listener.v3.Listener.address>` must not be set on the internal listeners.
	//
	// There are some limitations that are derived from the implementation. The known limitations include:
	//
	//   - :ref:`ConnectionBalanceConfig <envoy_v3_api_msg_config.listener.v3.Listener.ConnectionBalanceConfig>` is not
	//     allowed because both the cluster connection and the listener connection must be owned by the same dispatcher.
	//   - :ref:`tcp_backlog_size <envoy_v3_api_field_config.listener.v3.Listener.tcp_backlog_size>`
	//   - :ref:`freebind <envoy_v3_api_field_config.listener.v3.Listener.freebind>`
	//   - :ref:`transparent <envoy_v3_api_field_config.listener.v3.Listener.transparent>`
	InternalListener *Listener_InternalListenerConfig `protobuf:"bytes,27,opt,name=internal_listener,json=internalListener,proto3,oneof"`
}

type Listener_InternalListenerConfig 

type Listener_InternalListenerConfig struct {
	// contains filtered or unexported fields
}

Configuration for envoy internal listener. All the future internal listener features should be added here.

func (*Listener_InternalListenerConfig) ProtoMessage 

func (*Listener_InternalListenerConfig) ProtoMessage()

func (*Listener_InternalListenerConfig) ProtoReflect 

func (x *Listener_InternalListenerConfig) ProtoReflect() protoreflect.Message

func (*Listener_InternalListenerConfig) Reset 

func (x *Listener_InternalListenerConfig) Reset()

func (*Listener_InternalListenerConfig) String 

func (x *Listener_InternalListenerConfig) String() string

type Listener_InternalListenerConfig_builder 

type Listener_InternalListenerConfig_builder struct {
	// contains filtered or unexported fields
}

func (Listener_InternalListenerConfig_builder) Build 

func (b0 Listener_InternalListenerConfig_builder) Build() *Listener_InternalListenerConfig

type Listener_builder 

type Listener_builder struct {

	// The unique name by which this listener is known. If no name is provided,
	// Envoy will allocate an internal UUID for the listener. If the listener is to be dynamically
	// updated or removed via :ref:`LDS <config_listeners_lds>` a unique name must be provided.
	Name string
	// The address that the listener should listen on. In general, the address must be unique, though
	// that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
	// Linux as the actual port will be allocated by the OS.
	// Required unless “api_listener“ or “listener_specifier“ is populated.
	Address *v3.Address
	// The additional addresses the listener should listen on. The addresses must be unique across all
	// listeners. Multiple addresses with port 0 can be supplied. When using multiple addresses in a single listener,
	// all addresses use the same protocol, and multiple internal addresses are not supported.
	AdditionalAddresses []*AdditionalAddress
	// Optional prefix to use on listener stats. If empty, the stats will be rooted at
	// “listener.<address as string>.“. If non-empty, stats will be rooted at
	// “listener.<stat_prefix>.“.
	StatPrefix string
	// A list of filter chains to consider for this listener. The
	// :ref:`FilterChain <envoy_v3_api_msg_config.listener.v3.FilterChain>` with the most specific
	// :ref:`FilterChainMatch <envoy_v3_api_msg_config.listener.v3.FilterChainMatch>` criteria is used on a
	// connection.
	//
	// Example using SNI for filter chain selection can be found in the
	// :ref:`FAQ entry <faq_how_to_setup_sni>`.
	FilterChains []*FilterChain
	// Discover filter chains configurations by external service. Dynamic discovery of filter chains is allowed
	// while having statically configured filter chains, however, a filter chain name must be unique within a
	// listener. If a discovered filter chain matches a name of an existing filter chain, it is discarded.
	// [#not-implemented-hide:]
	FcdsConfig *Listener_FcdsConfig
	// :ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the
	// network properties. This matcher is used as a replacement for the filter chain match condition
	// :ref:`filter_chain_match
	// <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>`. If specified, all
	// :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>` must have a
	// non-empty and unique :ref:`name <envoy_v3_api_field_config.listener.v3.FilterChain.name>` field
	// and not specify :ref:`filter_chain_match
	// <envoy_v3_api_field_config.listener.v3.FilterChain.filter_chain_match>` field.
	//
	// .. note::
	//
	//	Once matched, each connection is permanently bound to its filter chain.
	//	If the matcher changes but the filter chain remains the same, the
	//	connections bound to the filter chain are not drained. If, however, the
	//	filter chain is removed or structurally modified, then the drain for its
	//	connections is initiated.
	FilterChainMatcher *v32.Matcher
	// If a connection is redirected using “iptables“, the port on which the proxy
	// receives it might be different from the original destination address. When this flag is set to
	// true, the listener hands off redirected connections to the listener associated with the
	// original destination address. If there is no listener associated with the original destination
	// address, the connection is handled by the listener that receives it. Defaults to false.
	UseOriginalDst *wrapperspb.BoolValue
	// The default filter chain if none of the filter chain matches. If no default filter chain is supplied,
	// the connection will be closed. The filter chain match is ignored in this field.
	DefaultFilterChain *FilterChain
	// Soft limit on size of the listener’s new connection read and write buffers.
	// If unspecified, an implementation defined default is applied (1MiB).
	PerConnectionBufferLimitBytes *wrapperspb.UInt32Value
	// Listener metadata.
	Metadata *v3.Metadata
	// [#not-implemented-hide:]
	//
	// Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.
	DeprecatedV1 *Listener_DeprecatedV1
	// The type of draining to perform at a listener-wide level.
	DrainType Listener_DrainType
	// Listener filters have the opportunity to manipulate and augment the connection metadata that
	// is used in connection filter chain matching, for example. These filters are run before any in
	// :ref:`filter_chains <envoy_v3_api_field_config.listener.v3.Listener.filter_chains>`. Order matters as the
	// filters are processed sequentially right after a socket has been accepted by the listener, and
	// before a connection is created.
	// UDP Listener filters can be specified when the protocol in the listener socket address in
	// :ref:`protocol <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
	// <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>` and no
	// :ref:`quic_options <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
	// QUIC listener filters can be specified when :ref:`quic_options
	// <envoy_v3_api_field_config.listener.v3.UdpListenerConfig.quic_options>` is
	// specified in :ref:`udp_listener_config <envoy_v3_api_field_config.listener.v3.Listener.udp_listener_config>`.
	// They are processed sequentially right before connection creation. And like TCP Listener filters, they can be used to manipulate the connection metadata and socket. But the difference is that they can't be used to pause connection creation.
	ListenerFilters []*ListenerFilter
	// The timeout to wait for all listener filters to complete operation. If the timeout is reached,
	// the accepted socket is closed without a connection being created unless
	// “continue_on_listener_filters_timeout“ is set to true. Specify 0 to disable the
	// timeout. If not specified, a default timeout of 15s is used.
	ListenerFiltersTimeout *durationpb.Duration
	// Whether a connection should be created when listener filters timeout. Default is false.
	//
	// .. attention::
	//
	//	Some listener filters, such as :ref:`Proxy Protocol filter
	//	<config_listener_filters_proxy_protocol>`, should not be used with this option. It will cause
	//	unexpected behavior when a connection is created.
	ContinueOnListenerFiltersTimeout bool
	// Whether the listener should be set as a transparent socket.
	// When this flag is set to true, connections can be redirected to the listener using an
	// “iptables“ “TPROXY“ target, in which case the original source and destination addresses and
	// ports are preserved on accepted connections. This flag should be used in combination with
	// :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
	// <envoy_v3_api_field_config.listener.v3.Listener.listener_filters>` to mark the connections' local addresses as
	// "restored." This can be used to hand off each redirected connection to another listener
	// associated with the connection's destination address. Direct connections to the socket without
	// using “TPROXY“ cannot be distinguished from connections redirected using “TPROXY“ and are
	// therefore treated as if they were redirected.
	// When this flag is set to false, the listener's socket is explicitly reset as non-transparent.
	// Setting this flag requires Envoy to run with the “CAP_NET_ADMIN“ capability.
	// When this flag is not set (default), the socket is not modified, i.e. the transparent option
	// is neither set nor reset.
	Transparent *wrapperspb.BoolValue
	// Whether the listener should set the “IP_FREEBIND“ socket option. When this
	// flag is set to true, listeners can be bound to an IP address that is not
	// configured on the system running Envoy. When this flag is set to false, the
	// option “IP_FREEBIND“ is disabled on the socket. When this flag is not set
	// (default), the socket is not modified, i.e. the option is neither enabled
	// nor disabled.
	Freebind *wrapperspb.BoolValue
	// Additional socket options that may not be present in Envoy source code or
	// precompiled binaries.
	// It is not allowed to update the socket options for any existing address if
	// :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>`
	// is “false“ to avoid the conflict when creating new sockets for the listener.
	SocketOptions []*v3.SocketOption
	// Whether the listener should accept TCP Fast Open (TFO) connections.
	// When this flag is set to a value greater than 0, the option TCP_FASTOPEN is enabled on
	// the socket, with a queue length of the specified size
	// (see `details in RFC7413 <https://tools.ietf.org/html/rfc7413#section-5.1>`_).
	// When this flag is set to 0, the option TCP_FASTOPEN is disabled on the socket.
	// When this flag is not set (default), the socket is not modified,
	// i.e. the option is neither enabled nor disabled.
	//
	// On Linux, the net.ipv4.tcp_fastopen kernel parameter must include flag 0x2 to enable
	// TCP_FASTOPEN.
	// See `ip-sysctl.txt <https://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt>`_.
	//
	// On macOS, only values of 0, 1, and unset are valid; other values may result in an error.
	// To set the queue length on macOS, set the net.inet.tcp.fastopen_backlog kernel parameter.
	TcpFastOpenQueueLength *wrapperspb.UInt32Value
	// Specifies the intended direction of the traffic relative to the local Envoy.
	// This property is required on Windows for listeners using the original destination filter,
	// see :ref:`Original Destination <config_listener_filters_original_dst>`.
	TrafficDirection v3.TrafficDirection
	// If the protocol in the listener socket address in :ref:`protocol
	// <envoy_v3_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
	// <envoy_v3_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies UDP
	// listener specific configuration.
	UdpListenerConfig *UdpListenerConfig
	// Used to represent an API listener, which is used in non-proxy clients. The type of API
	// exposed to the non-proxy application depends on the type of API listener.
	// When this field is set, no other field except for :ref:`name<envoy_v3_api_field_config.listener.v3.Listener.name>`
	// should be set.
	//
	// .. note::
	//
	//	Currently only one ApiListener can be installed; and it can only be done via bootstrap config,
	//	not LDS.
	//
	// [#next-major-version: In the v3 API, instead of this messy approach where the socket
	// listener fields are directly in the top-level Listener message and the API listener types
	// are in the ApiListener message, the socket listener messages should be in their own message,
	// and the top-level Listener should essentially be a oneof that selects between the
	// socket listener and the various types of API listener. That way, a given Listener message
	// can structurally only contain the fields of the relevant type.]
	ApiListener *ApiListener
	// The listener's connection balancer configuration, currently only applicable to TCP listeners.
	// If no configuration is specified, Envoy will not attempt to balance active connections between
	// worker threads.
	//
	// In the scenario that the listener X redirects all the connections to the listeners Y1 and Y2
	// by setting :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>` in X
	// and :ref:`bind_to_port <envoy_v3_api_field_config.listener.v3.Listener.bind_to_port>` to false in Y1 and Y2,
	// it is recommended to disable the balance config in listener X to avoid the cost of balancing, and
	// enable the balance config in Y1 and Y2 to balance the connections among the workers.
	ConnectionBalanceConfig *Listener_ConnectionBalanceConfig
	// Deprecated. Use “enable_reuse_port“ instead.
	//
	// Deprecated: Marked as deprecated in envoy/config/listener/v3/listener.proto.
	ReusePort bool
	// When this flag is set to true, listeners set the “SO_REUSEPORT“ socket option and
	// create one socket for each worker thread. This makes inbound connections
	// distribute among worker threads roughly evenly in cases where there are a high number
	// of connections. When this flag is set to false, all worker threads share one socket. This field
	// defaults to true. The change of field will be rejected during an listener update when the
	// runtime flag “envoy.reloadable_features.enable_update_listener_socket_options“ is enabled.
	// Otherwise, the update of this field will be ignored quietly.
	//
	// .. attention::
	//
	//	Although this field defaults to true, it has different behavior on different platforms. See
	//	the following text for more information.
	//
	//   - On Linux, reuse_port is respected for both TCP and UDP listeners. It also works correctly
	//     with hot restart.
	//   - On macOS, reuse_port for TCP does not do what it does on Linux. Instead of load balancing,
	//     the last socket wins and receives all connections/packets. For TCP, reuse_port is force
	//     disabled and the user is warned. For UDP, it is enabled, but only one worker will receive
	//     packets. For QUIC/H3, SW routing will send packets to other workers. For "raw" UDP, only
	//     a single worker will currently receive packets.
	//   - On Windows, reuse_port for TCP has undefined behavior. It is force disabled and the user
	//     is warned similar to macOS. It is left enabled for UDP with undefined behavior currently.
	EnableReusePort *wrapperspb.BoolValue
	// Configuration for :ref:`access logs <arch_overview_access_logs>`
	// emitted by this listener.
	AccessLog []*v33.AccessLog
	// The maximum length a tcp listener's pending connections queue can grow to. If no value is
	// provided net.core.somaxconn will be used on Linux and 128 otherwise.
	TcpBacklogSize *wrapperspb.UInt32Value
	// The maximum number of connections to accept from the kernel per socket
	// event. Envoy may decide to close these connections after accepting them
	// from the kernel e.g. due to load shedding, or other policies.
	// If there are more than max_connections_to_accept_per_socket_event
	// connections pending accept, connections over this threshold will be
	// accepted in later event loop iterations.
	// If no value is provided Envoy will accept all connections pending accept
	// from the kernel.
	//
	// .. note::
	//
	//	It is recommended to lower this value for better overload management and reduced per-event cost.
	//	Setting it to 1 is a viable option with no noticeable impact on performance.
	MaxConnectionsToAcceptPerSocketEvent *wrapperspb.UInt32Value
	// Whether the listener should bind to the port. A listener that doesn't
	// bind can only receive connections redirected from other listeners that set
	// :ref:`use_original_dst <envoy_v3_api_field_config.listener.v3.Listener.use_original_dst>`
	// to true. Default is true.
	BindToPort *wrapperspb.BoolValue

	// Fields of oneof ListenerSpecifier:
	// Used to represent an internal listener which does not listen on OSI L4 address but can be used by the
	// :ref:`envoy cluster <envoy_v3_api_msg_config.cluster.v3.Cluster>` to create a user space connection to.
	// The internal listener acts as a TCP listener. It supports listener filters and network filter chains.
	// Upstream clusters refer to the internal listeners by their :ref:`name
	// <envoy_v3_api_field_config.listener.v3.Listener.name>`. :ref:`Address
	// <envoy_v3_api_field_config.listener.v3.Listener.address>` must not be set on the internal listeners.
	//
	// There are some limitations that are derived from the implementation. The known limitations include:
	//
	//   - :ref:`ConnectionBalanceConfig <envoy_v3_api_msg_config.listener.v3.Listener.ConnectionBalanceConfig>` is not
	//     allowed because both the cluster connection and the listener connection must be owned by the same dispatcher.
	//   - :ref:`tcp_backlog_size <envoy_v3_api_field_config.listener.v3.Listener.tcp_backlog_size>`
	//   - :ref:`freebind <envoy_v3_api_field_config.listener.v3.Listener.freebind>`
	//   - :ref:`transparent <envoy_v3_api_field_config.listener.v3.Listener.transparent>`
	InternalListener *Listener_InternalListenerConfig
	// -- end of ListenerSpecifier
	// Enable MPTCP (multi-path TCP) on this listener. Clients will be allowed to establish
	// MPTCP connections. Non-MPTCP clients will fall back to regular TCP.
	EnableMptcp bool
	// Whether the listener should limit connections based upon the value of
	// :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`.
	IgnoreGlobalConnLimit bool
	// Whether the listener bypasses configured overload manager actions.
	BypassOverloadManager bool
	// contains filtered or unexported fields
}

func (Listener_builder) Build 

func (b0 Listener_builder) Build() *Listener

type QuicProtocolOptions 

type QuicProtocolOptions struct {
	QuicProtocolOptions *v3.QuicProtocolOptions `protobuf:"bytes,1,opt,name=quic_protocol_options,json=quicProtocolOptions,proto3" json:"quic_protocol_options,omitempty"`
	// 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.
	IdleTimeout *durationpb.Duration `protobuf:"bytes,2,opt,name=idle_timeout,json=idleTimeout,proto3" json:"idle_timeout,omitempty"`
	// Connection timeout in milliseconds before the crypto handshake is finished.
	//
	// If it is less than 5000ms, Envoy will use 5000ms. 20000ms if not specified.
	CryptoHandshakeTimeout *durationpb.Duration `` /* 129-byte string literal not displayed */
	// Runtime flag that controls whether the listener is enabled or not. If not specified, defaults
	// to enabled.
	Enabled *v3.RuntimeFeatureFlag `protobuf:"bytes,4,opt,name=enabled,proto3" json:"enabled,omitempty"`
	// 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.
	PacketsToReadToConnectionCountRatio *wrapperspb.UInt32Value `` /* 176-byte string literal not displayed */
	// 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]
	CryptoStreamConfig *v3.TypedExtensionConfig `protobuf:"bytes,6,opt,name=crypto_stream_config,json=cryptoStreamConfig,proto3" json:"crypto_stream_config,omitempty"`
	// 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]
	ProofSourceConfig *v3.TypedExtensionConfig `protobuf:"bytes,7,opt,name=proof_source_config,json=proofSourceConfig,proto3" json:"proof_source_config,omitempty"`
	// 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]
	ConnectionIdGeneratorConfig *v3.TypedExtensionConfig `` /* 146-byte string literal not displayed */
	// 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]
	ServerPreferredAddressConfig *v3.TypedExtensionConfig `` /* 149-byte string literal not displayed */
	// 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).
	SendDisableActiveMigration *wrapperspb.BoolValue `` /* 144-byte string literal not displayed */
	// 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]
	ConnectionDebugVisitorConfig *v3.TypedExtensionConfig `` /* 150-byte string literal not displayed */
	// Configure a type of UDP cmsg to pass to listener filters via QuicReceivedPacket.
	// Both level and type must be specified for cmsg to be saved.
	// Cmsg may be truncated or omitted if expected size is not set.
	// If not specified, no cmsg will be saved to QuicReceivedPacket.
	SaveCmsgConfig []*v3.SocketCmsgHeaders `protobuf:"bytes,12,rep,name=save_cmsg_config,json=saveCmsgConfig,proto3" json:"save_cmsg_config,omitempty"`
	// If true, the listener will reject connection-establishing packets at the
	// QUIC layer by replying with an empty version negotiation packet to the
	// client.
	RejectNewConnections bool `protobuf:"varint,13,opt,name=reject_new_connections,json=rejectNewConnections,proto3" json:"reject_new_connections,omitempty"`
	// contains filtered or unexported fields
}

Configuration specific to the UDP QUIC listener. [#next-free-field: 14]

func (*QuicProtocolOptions) ClearConnectionDebugVisitorConfig 

func (x *QuicProtocolOptions) ClearConnectionDebugVisitorConfig()

func (*QuicProtocolOptions) ClearConnectionIdGeneratorConfig 

func (x *QuicProtocolOptions) ClearConnectionIdGeneratorConfig()

func (*QuicProtocolOptions) ClearCryptoHandshakeTimeout 

func (x *QuicProtocolOptions) ClearCryptoHandshakeTimeout()

func (*QuicProtocolOptions) ClearCryptoStreamConfig 

func (x *QuicProtocolOptions) ClearCryptoStreamConfig()

func (*QuicProtocolOptions) ClearEnabled 

func (x *QuicProtocolOptions) ClearEnabled()

func (*QuicProtocolOptions) ClearIdleTimeout 

func (x *QuicProtocolOptions) ClearIdleTimeout()

func (*QuicProtocolOptions) ClearPacketsToReadToConnectionCountRatio 

func (x *QuicProtocolOptions) ClearPacketsToReadToConnectionCountRatio()

func (*QuicProtocolOptions) ClearProofSourceConfig 

func (x *QuicProtocolOptions) ClearProofSourceConfig()

func (*QuicProtocolOptions) ClearQuicProtocolOptions 

func (x *QuicProtocolOptions) ClearQuicProtocolOptions()

func (*QuicProtocolOptions) ClearSendDisableActiveMigration 

func (x *QuicProtocolOptions) ClearSendDisableActiveMigration()

func (*QuicProtocolOptions) ClearServerPreferredAddressConfig 

func (x *QuicProtocolOptions) ClearServerPreferredAddressConfig()

func (*QuicProtocolOptions) GetConnectionDebugVisitorConfig 

func (x *QuicProtocolOptions) GetConnectionDebugVisitorConfig() *v3.TypedExtensionConfig

func (*QuicProtocolOptions) GetConnectionIdGeneratorConfig 

func (x *QuicProtocolOptions) GetConnectionIdGeneratorConfig() *v3.TypedExtensionConfig

func (*QuicProtocolOptions) GetCryptoHandshakeTimeout 

func (x *QuicProtocolOptions) GetCryptoHandshakeTimeout() *durationpb.Duration

func (*QuicProtocolOptions) GetCryptoStreamConfig 

func (x *QuicProtocolOptions) GetCryptoStreamConfig() *v3.TypedExtensionConfig

func (*QuicProtocolOptions) GetEnabled 

func (x *QuicProtocolOptions) GetEnabled() *v3.RuntimeFeatureFlag

func (*QuicProtocolOptions) GetIdleTimeout 

func (x *QuicProtocolOptions) GetIdleTimeout() *durationpb.Duration

func (*QuicProtocolOptions) GetPacketsToReadToConnectionCountRatio 

func (x *QuicProtocolOptions) GetPacketsToReadToConnectionCountRatio() *wrapperspb.UInt32Value

func (*QuicProtocolOptions) GetProofSourceConfig 

func (x *QuicProtocolOptions) GetProofSourceConfig() *v3.TypedExtensionConfig

func (*QuicProtocolOptions) GetQuicProtocolOptions 

func (x *QuicProtocolOptions) GetQuicProtocolOptions() *v3.QuicProtocolOptions

func (*QuicProtocolOptions) GetRejectNewConnections 

func (x *QuicProtocolOptions) GetRejectNewConnections() bool

func (*QuicProtocolOptions) GetSaveCmsgConfig 

func (x *QuicProtocolOptions) GetSaveCmsgConfig() []*v3.SocketCmsgHeaders

func (*QuicProtocolOptions) GetSendDisableActiveMigration 

func (x *QuicProtocolOptions) GetSendDisableActiveMigration() *wrapperspb.BoolValue

func (*QuicProtocolOptions) GetServerPreferredAddressConfig 

func (x *QuicProtocolOptions) GetServerPreferredAddressConfig() *v3.TypedExtensionConfig

func (*QuicProtocolOptions) HasConnectionDebugVisitorConfig 

func (x *QuicProtocolOptions) HasConnectionDebugVisitorConfig() bool

func (*QuicProtocolOptions) HasConnectionIdGeneratorConfig 

func (x *QuicProtocolOptions) HasConnectionIdGeneratorConfig() bool

func (*QuicProtocolOptions) HasCryptoHandshakeTimeout 

func (x *QuicProtocolOptions) HasCryptoHandshakeTimeout() bool

func (*QuicProtocolOptions) HasCryptoStreamConfig 

func (x *QuicProtocolOptions) HasCryptoStreamConfig() bool

func (*QuicProtocolOptions) HasEnabled 

func (x *QuicProtocolOptions) HasEnabled() bool

func (*QuicProtocolOptions) HasIdleTimeout 

func (x *QuicProtocolOptions) HasIdleTimeout() bool

func (*QuicProtocolOptions) HasPacketsToReadToConnectionCountRatio 

func (x *QuicProtocolOptions) HasPacketsToReadToConnectionCountRatio() bool

func (*QuicProtocolOptions) HasProofSourceConfig 

func (x *QuicProtocolOptions) HasProofSourceConfig() bool

func (*QuicProtocolOptions) HasQuicProtocolOptions 

func (x *QuicProtocolOptions) HasQuicProtocolOptions() bool

func (*QuicProtocolOptions) HasSendDisableActiveMigration 

func (x *QuicProtocolOptions) HasSendDisableActiveMigration() bool

func (*QuicProtocolOptions) HasServerPreferredAddressConfig 

func (x *QuicProtocolOptions) HasServerPreferredAddressConfig() bool

func (*QuicProtocolOptions) ProtoMessage 

func (*QuicProtocolOptions) ProtoMessage()

func (*QuicProtocolOptions) ProtoReflect 

func (x *QuicProtocolOptions) ProtoReflect() protoreflect.Message

func (*QuicProtocolOptions) Reset 

func (x *QuicProtocolOptions) Reset()

func (*QuicProtocolOptions) SetConnectionDebugVisitorConfig 

func (x *QuicProtocolOptions) SetConnectionDebugVisitorConfig(v *v3.TypedExtensionConfig)

func (*QuicProtocolOptions) SetConnectionIdGeneratorConfig 

func (x *QuicProtocolOptions) SetConnectionIdGeneratorConfig(v *v3.TypedExtensionConfig)

func (*QuicProtocolOptions) SetCryptoHandshakeTimeout 

func (x *QuicProtocolOptions) SetCryptoHandshakeTimeout(v *durationpb.Duration)

func (*QuicProtocolOptions) SetCryptoStreamConfig 

func (x *QuicProtocolOptions) SetCryptoStreamConfig(v *v3.TypedExtensionConfig)

func (*QuicProtocolOptions) SetEnabled 

func (x *QuicProtocolOptions) SetEnabled(v *v3.RuntimeFeatureFlag)

func (*QuicProtocolOptions) SetIdleTimeout 

func (x *QuicProtocolOptions) SetIdleTimeout(v *durationpb.Duration)

func (*QuicProtocolOptions) SetPacketsToReadToConnectionCountRatio 

func (x *QuicProtocolOptions) SetPacketsToReadToConnectionCountRatio(v *wrapperspb.UInt32Value)

func (*QuicProtocolOptions) SetProofSourceConfig 

func (x *QuicProtocolOptions) SetProofSourceConfig(v *v3.TypedExtensionConfig)

func (*QuicProtocolOptions) SetQuicProtocolOptions 

func (x *QuicProtocolOptions) SetQuicProtocolOptions(v *v3.QuicProtocolOptions)

func (*QuicProtocolOptions) SetRejectNewConnections 

func (x *QuicProtocolOptions) SetRejectNewConnections(v bool)

func (*QuicProtocolOptions) SetSaveCmsgConfig 

func (x *QuicProtocolOptions) SetSaveCmsgConfig(v []*v3.SocketCmsgHeaders)

func (*QuicProtocolOptions) SetSendDisableActiveMigration 

func (x *QuicProtocolOptions) SetSendDisableActiveMigration(v *wrapperspb.BoolValue)

func (*QuicProtocolOptions) SetServerPreferredAddressConfig 

func (x *QuicProtocolOptions) SetServerPreferredAddressConfig(v *v3.TypedExtensionConfig)

func (*QuicProtocolOptions) String 

func (x *QuicProtocolOptions) String() string

type QuicProtocolOptions_builder 

type QuicProtocolOptions_builder struct {
	QuicProtocolOptions *v3.QuicProtocolOptions
	// 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.
	IdleTimeout *durationpb.Duration
	// Connection timeout in milliseconds before the crypto handshake is finished.
	//
	// If it is less than 5000ms, Envoy will use 5000ms. 20000ms if not specified.
	CryptoHandshakeTimeout *durationpb.Duration
	// Runtime flag that controls whether the listener is enabled or not. If not specified, defaults
	// to enabled.
	Enabled *v3.RuntimeFeatureFlag
	// 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.
	PacketsToReadToConnectionCountRatio *wrapperspb.UInt32Value
	// 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]
	CryptoStreamConfig *v3.TypedExtensionConfig
	// 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]
	ProofSourceConfig *v3.TypedExtensionConfig
	// 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]
	ConnectionIdGeneratorConfig *v3.TypedExtensionConfig
	// 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]
	ServerPreferredAddressConfig *v3.TypedExtensionConfig
	// 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).
	SendDisableActiveMigration *wrapperspb.BoolValue
	// 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]
	ConnectionDebugVisitorConfig *v3.TypedExtensionConfig
	// Configure a type of UDP cmsg to pass to listener filters via QuicReceivedPacket.
	// Both level and type must be specified for cmsg to be saved.
	// Cmsg may be truncated or omitted if expected size is not set.
	// If not specified, no cmsg will be saved to QuicReceivedPacket.
	SaveCmsgConfig []*v3.SocketCmsgHeaders
	// If true, the listener will reject connection-establishing packets at the
	// QUIC layer by replying with an empty version negotiation packet to the
	// client.
	RejectNewConnections bool
	// contains filtered or unexported fields
}

func (QuicProtocolOptions_builder) Build 

func (b0 QuicProtocolOptions_builder) Build() *QuicProtocolOptions

type UdpListenerConfig 

type UdpListenerConfig struct {

	// UDP socket configuration for the listener. The default for
	// :ref:`prefer_gro <envoy_v3_api_field_config.core.v3.UdpSocketConfig.prefer_gro>` is false for
	// listener sockets. If receiving a large amount of datagrams from a small number of sources, it
	// may be worthwhile to enable this option after performance testing.
	DownstreamSocketConfig *v3.UdpSocketConfig `` /* 129-byte string literal not displayed */
	// Configuration for QUIC protocol. If empty, QUIC will not be enabled on this listener. Set
	// to the default object to enable QUIC without modifying any additional options.
	QuicOptions *QuicProtocolOptions `protobuf:"bytes,7,opt,name=quic_options,json=quicOptions,proto3" json:"quic_options,omitempty"`
	// Configuration for the UDP packet writer. If empty, HTTP/3 will use GSO if available
	// (:ref:`UdpDefaultWriterFactory <envoy_v3_api_msg_extensions.udp_packet_writer.v3.UdpGsoBatchWriterFactory>`)
	// or the default kernel sendmsg if not,
	// (:ref:`UdpDefaultWriterFactory <envoy_v3_api_msg_extensions.udp_packet_writer.v3.UdpDefaultWriterFactory>`)
	// and raw UDP will use kernel sendmsg.
	// [#extension-category: envoy.udp_packet_writer]
	UdpPacketPacketWriterConfig *v3.TypedExtensionConfig `` /* 148-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 9]

func (*UdpListenerConfig) ClearDownstreamSocketConfig 

func (x *UdpListenerConfig) ClearDownstreamSocketConfig()

func (*UdpListenerConfig) ClearQuicOptions 

func (x *UdpListenerConfig) ClearQuicOptions()

func (*UdpListenerConfig) ClearUdpPacketPacketWriterConfig 

func (x *UdpListenerConfig) ClearUdpPacketPacketWriterConfig()

func (*UdpListenerConfig) GetDownstreamSocketConfig 

func (x *UdpListenerConfig) GetDownstreamSocketConfig() *v3.UdpSocketConfig

func (*UdpListenerConfig) GetQuicOptions 

func (x *UdpListenerConfig) GetQuicOptions() *QuicProtocolOptions

func (*UdpListenerConfig) GetUdpPacketPacketWriterConfig 

func (x *UdpListenerConfig) GetUdpPacketPacketWriterConfig() *v3.TypedExtensionConfig

func (*UdpListenerConfig) HasDownstreamSocketConfig 

func (x *UdpListenerConfig) HasDownstreamSocketConfig() bool

func (*UdpListenerConfig) HasQuicOptions 

func (x *UdpListenerConfig) HasQuicOptions() bool

func (*UdpListenerConfig) HasUdpPacketPacketWriterConfig 

func (x *UdpListenerConfig) HasUdpPacketPacketWriterConfig() bool

func (*UdpListenerConfig) ProtoMessage 

func (*UdpListenerConfig) ProtoMessage()

func (*UdpListenerConfig) ProtoReflect 

func (x *UdpListenerConfig) ProtoReflect() protoreflect.Message

func (*UdpListenerConfig) Reset 

func (x *UdpListenerConfig) Reset()

func (*UdpListenerConfig) SetDownstreamSocketConfig 

func (x *UdpListenerConfig) SetDownstreamSocketConfig(v *v3.UdpSocketConfig)

func (*UdpListenerConfig) SetQuicOptions 

func (x *UdpListenerConfig) SetQuicOptions(v *QuicProtocolOptions)

func (*UdpListenerConfig) SetUdpPacketPacketWriterConfig 

func (x *UdpListenerConfig) SetUdpPacketPacketWriterConfig(v *v3.TypedExtensionConfig)

func (*UdpListenerConfig) String 

func (x *UdpListenerConfig) String() string

type UdpListenerConfig_builder 

type UdpListenerConfig_builder struct {

	// UDP socket configuration for the listener. The default for
	// :ref:`prefer_gro <envoy_v3_api_field_config.core.v3.UdpSocketConfig.prefer_gro>` is false for
	// listener sockets. If receiving a large amount of datagrams from a small number of sources, it
	// may be worthwhile to enable this option after performance testing.
	DownstreamSocketConfig *v3.UdpSocketConfig
	// Configuration for QUIC protocol. If empty, QUIC will not be enabled on this listener. Set
	// to the default object to enable QUIC without modifying any additional options.
	QuicOptions *QuicProtocolOptions
	// Configuration for the UDP packet writer. If empty, HTTP/3 will use GSO if available
	// (:ref:`UdpDefaultWriterFactory <envoy_v3_api_msg_extensions.udp_packet_writer.v3.UdpGsoBatchWriterFactory>`)
	// or the default kernel sendmsg if not,
	// (:ref:`UdpDefaultWriterFactory <envoy_v3_api_msg_extensions.udp_packet_writer.v3.UdpDefaultWriterFactory>`)
	// and raw UDP will use kernel sendmsg.
	// [#extension-category: envoy.udp_packet_writer]
	UdpPacketPacketWriterConfig *v3.TypedExtensionConfig
	// contains filtered or unexported fields
}

func (UdpListenerConfig_builder) Build 

func (b0 UdpListenerConfig_builder) Build() *UdpListenerConfig

type ValidationListenerManager 

type ValidationListenerManager struct {
	// contains filtered or unexported fields
}

A placeholder proto so that users can explicitly configure the standard Validation Listener Manager via the bootstrap's :ref:`listener_manager <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.listener_manager>`. [#not-implemented-hide:]

func (*ValidationListenerManager) ProtoMessage 

func (*ValidationListenerManager) ProtoMessage()

func (*ValidationListenerManager) ProtoReflect 

func (x *ValidationListenerManager) ProtoReflect() protoreflect.Message

func (*ValidationListenerManager) Reset 

func (x *ValidationListenerManager) Reset()

func (*ValidationListenerManager) String 

func (x *ValidationListenerManager) String() string

type ValidationListenerManager_builder 

type ValidationListenerManager_builder struct {
	// contains filtered or unexported fields
}

func (ValidationListenerManager_builder) Build 

func (b0 ValidationListenerManager_builder) Build() *ValidationListenerManager

Source Files

  • api_listener.pb.go
  • listener.pb.go
  • listener_components.pb.go
  • quic_config.pb.go
  • udp_listener_config.pb.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.