public interface ListenerOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
AccessLog |
getAccessLog(int index)
Configuration for :ref:`access logs <arch_overview_access_logs>`
emitted by this listener.
|
int |
getAccessLogCount()
Configuration for :ref:`access logs <arch_overview_access_logs>`
emitted by this listener.
|
List<AccessLog> |
getAccessLogList()
Configuration for :ref:`access logs <arch_overview_access_logs>`
emitted by this listener.
|
AccessLogOrBuilder |
getAccessLogOrBuilder(int index)
Configuration for :ref:`access logs <arch_overview_access_logs>`
emitted by this listener.
|
List<? extends AccessLogOrBuilder> |
getAccessLogOrBuilderList()
Configuration for :ref:`access logs <arch_overview_access_logs>`
emitted by this listener.
|
Address |
getAddress()
The address that the listener should listen on.
|
AddressOrBuilder |
getAddressOrBuilder()
The address that the listener should listen on.
|
ApiListener |
getApiListener()
Used to represent an API listener, which is used in non-proxy clients.
|
ApiListenerOrBuilder |
getApiListenerOrBuilder()
Used to represent an API listener, which is used in non-proxy clients.
|
com.google.protobuf.BoolValue |
getBindToPort()
Whether the listener should bind to the port.
|
com.google.protobuf.BoolValueOrBuilder |
getBindToPortOrBuilder()
Whether the listener should bind to the port.
|
Listener.ConnectionBalanceConfig |
getConnectionBalanceConfig()
The listener's connection balancer configuration, currently only applicable to TCP listeners.
|
Listener.ConnectionBalanceConfigOrBuilder |
getConnectionBalanceConfigOrBuilder()
The listener's connection balancer configuration, currently only applicable to TCP listeners.
|
boolean |
getContinueOnListenerFiltersTimeout()
Whether a connection should be created when listener filters timeout.
|
FilterChain |
getDefaultFilterChain()
The default filter chain if none of the filter chain matches.
|
FilterChainOrBuilder |
getDefaultFilterChainOrBuilder()
The default filter chain if none of the filter chain matches.
|
Listener.DeprecatedV1 |
getDeprecatedV1()
Deprecated.
|
Listener.DeprecatedV1OrBuilder |
getDeprecatedV1OrBuilder()
Deprecated.
|
Listener.DrainType |
getDrainType()
The type of draining to perform at a listener-wide level.
|
int |
getDrainTypeValue()
The type of draining to perform at a listener-wide level.
|
FilterChain |
getFilterChains(int index)
A list of filter chains to consider for this listener.
|
int |
getFilterChainsCount()
A list of filter chains to consider for this listener.
|
List<FilterChain> |
getFilterChainsList()
A list of filter chains to consider for this listener.
|
FilterChainOrBuilder |
getFilterChainsOrBuilder(int index)
A list of filter chains to consider for this listener.
|
List<? extends FilterChainOrBuilder> |
getFilterChainsOrBuilderList()
A list of filter chains to consider for this listener.
|
com.google.protobuf.BoolValue |
getFreebind()
Whether the listener should set the *IP_FREEBIND* socket option.
|
com.google.protobuf.BoolValueOrBuilder |
getFreebindOrBuilder()
Whether the listener should set the *IP_FREEBIND* socket option.
|
ListenerFilter |
getListenerFilters(int index)
Listener filters have the opportunity to manipulate and augment the connection metadata that
is used in connection filter chain matching, for example.
|
int |
getListenerFiltersCount()
Listener filters have the opportunity to manipulate and augment the connection metadata that
is used in connection filter chain matching, for example.
|
List<ListenerFilter> |
getListenerFiltersList()
Listener filters have the opportunity to manipulate and augment the connection metadata that
is used in connection filter chain matching, for example.
|
ListenerFilterOrBuilder |
getListenerFiltersOrBuilder(int index)
Listener filters have the opportunity to manipulate and augment the connection metadata that
is used in connection filter chain matching, for example.
|
List<? extends ListenerFilterOrBuilder> |
getListenerFiltersOrBuilderList()
Listener filters have the opportunity to manipulate and augment the connection metadata that
is used in connection filter chain matching, for example.
|
com.google.protobuf.Duration |
getListenerFiltersTimeout()
The timeout to wait for all listener filters to complete operation.
|
com.google.protobuf.DurationOrBuilder |
getListenerFiltersTimeoutOrBuilder()
The timeout to wait for all listener filters to complete operation.
|
Metadata |
getMetadata()
Listener metadata.
|
MetadataOrBuilder |
getMetadataOrBuilder()
Listener metadata.
|
String |
getName()
The unique name by which this listener is known.
|
com.google.protobuf.ByteString |
getNameBytes()
The unique name by which this listener is known.
|
com.google.protobuf.UInt32Value |
getPerConnectionBufferLimitBytes()
Soft limit on size of the listener’s new connection read and write buffers.
|
com.google.protobuf.UInt32ValueOrBuilder |
getPerConnectionBufferLimitBytesOrBuilder()
Soft limit on size of the listener’s new connection read and write buffers.
|
boolean |
getReusePort()
When this flag is set to true, listeners set the *SO_REUSEPORT* socket option and
create one socket for each worker thread.
|
SocketOption |
getSocketOptions(int index)
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
int |
getSocketOptionsCount()
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
List<SocketOption> |
getSocketOptionsList()
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
SocketOptionOrBuilder |
getSocketOptionsOrBuilder(int index)
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
List<? extends SocketOptionOrBuilder> |
getSocketOptionsOrBuilderList()
Additional socket options that may not be present in Envoy source code or
precompiled binaries.
|
com.google.protobuf.UInt32Value |
getTcpBacklogSize()
The maximum length a tcp listener's pending connections queue can grow to.
|
com.google.protobuf.UInt32ValueOrBuilder |
getTcpBacklogSizeOrBuilder()
The maximum length a tcp listener's pending connections queue can grow to.
|
com.google.protobuf.UInt32Value |
getTcpFastOpenQueueLength()
Whether the listener should accept TCP Fast Open (TFO) connections.
|
com.google.protobuf.UInt32ValueOrBuilder |
getTcpFastOpenQueueLengthOrBuilder()
Whether the listener should accept TCP Fast Open (TFO) connections.
|
TrafficDirection |
getTrafficDirection()
Specifies the intended direction of the traffic relative to the local Envoy.
|
int |
getTrafficDirectionValue()
Specifies the intended direction of the traffic relative to the local Envoy.
|
com.google.protobuf.BoolValue |
getTransparent()
Whether the listener should be set as a transparent socket.
|
com.google.protobuf.BoolValueOrBuilder |
getTransparentOrBuilder()
Whether the listener should be set as a transparent socket.
|
UdpListenerConfig |
getUdpListenerConfig()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
listener to create, i.e.
|
UdpListenerConfigOrBuilder |
getUdpListenerConfigOrBuilder()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
listener to create, i.e.
|
TypedExtensionConfig |
getUdpWriterConfig()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
writer to create, i.e.
|
TypedExtensionConfigOrBuilder |
getUdpWriterConfigOrBuilder()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
writer to create, i.e.
|
com.google.protobuf.BoolValue |
getUseOriginalDst()
If a connection is redirected using *iptables*, the port on which the proxy
receives it might be different from the original destination address.
|
com.google.protobuf.BoolValueOrBuilder |
getUseOriginalDstOrBuilder()
If a connection is redirected using *iptables*, the port on which the proxy
receives it might be different from the original destination address.
|
boolean |
hasAddress()
The address that the listener should listen on.
|
boolean |
hasApiListener()
Used to represent an API listener, which is used in non-proxy clients.
|
boolean |
hasBindToPort()
Whether the listener should bind to the port.
|
boolean |
hasConnectionBalanceConfig()
The listener's connection balancer configuration, currently only applicable to TCP listeners.
|
boolean |
hasDefaultFilterChain()
The default filter chain if none of the filter chain matches.
|
boolean |
hasDeprecatedV1()
Deprecated.
|
boolean |
hasFreebind()
Whether the listener should set the *IP_FREEBIND* socket option.
|
boolean |
hasListenerFiltersTimeout()
The timeout to wait for all listener filters to complete operation.
|
boolean |
hasMetadata()
Listener metadata.
|
boolean |
hasPerConnectionBufferLimitBytes()
Soft limit on size of the listener’s new connection read and write buffers.
|
boolean |
hasTcpBacklogSize()
The maximum length a tcp listener's pending connections queue can grow to.
|
boolean |
hasTcpFastOpenQueueLength()
Whether the listener should accept TCP Fast Open (TFO) connections.
|
boolean |
hasTransparent()
Whether the listener should be set as a transparent socket.
|
boolean |
hasUdpListenerConfig()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
listener to create, i.e.
|
boolean |
hasUdpWriterConfig()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
writer to create, i.e.
|
boolean |
hasUseOriginalDst()
If a connection is redirected using *iptables*, the port on which the proxy
receives it might be different from the original destination address.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getName()
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.
string name = 1;com.google.protobuf.ByteString getNameBytes()
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.
string name = 1;boolean hasAddress()
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.
.envoy.config.core.v3.Address address = 2 [(.validate.rules) = { ... }Address getAddress()
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.
.envoy.config.core.v3.Address address = 2 [(.validate.rules) = { ... }AddressOrBuilder getAddressOrBuilder()
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.
.envoy.config.core.v3.Address address = 2 [(.validate.rules) = { ... }List<FilterChain> getFilterChainsList()
A list of filter chains to consider for this listener. The :ref:`FilterChain <envoy_api_msg_config.listener.v3.FilterChain>` with the most specific :ref:`FilterChainMatch <envoy_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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;FilterChain getFilterChains(int index)
A list of filter chains to consider for this listener. The :ref:`FilterChain <envoy_api_msg_config.listener.v3.FilterChain>` with the most specific :ref:`FilterChainMatch <envoy_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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;int getFilterChainsCount()
A list of filter chains to consider for this listener. The :ref:`FilterChain <envoy_api_msg_config.listener.v3.FilterChain>` with the most specific :ref:`FilterChainMatch <envoy_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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;List<? extends FilterChainOrBuilder> getFilterChainsOrBuilderList()
A list of filter chains to consider for this listener. The :ref:`FilterChain <envoy_api_msg_config.listener.v3.FilterChain>` with the most specific :ref:`FilterChainMatch <envoy_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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;FilterChainOrBuilder getFilterChainsOrBuilder(int index)
A list of filter chains to consider for this listener. The :ref:`FilterChain <envoy_api_msg_config.listener.v3.FilterChain>` with the most specific :ref:`FilterChainMatch <envoy_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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;boolean hasUseOriginalDst()
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.
.google.protobuf.BoolValue use_original_dst = 4;com.google.protobuf.BoolValue getUseOriginalDst()
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.
.google.protobuf.BoolValue use_original_dst = 4;com.google.protobuf.BoolValueOrBuilder getUseOriginalDstOrBuilder()
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.
.google.protobuf.BoolValue use_original_dst = 4;boolean hasDefaultFilterChain()
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.
.envoy.config.listener.v3.FilterChain default_filter_chain = 25;FilterChain getDefaultFilterChain()
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.
.envoy.config.listener.v3.FilterChain default_filter_chain = 25;FilterChainOrBuilder getDefaultFilterChainOrBuilder()
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.
.envoy.config.listener.v3.FilterChain default_filter_chain = 25;boolean hasPerConnectionBufferLimitBytes()
Soft limit on size of the listener’s new connection read and write buffers. If unspecified, an implementation defined default is applied (1MiB).
.google.protobuf.UInt32Value per_connection_buffer_limit_bytes = 5 [(.udpa.annotations.security) = { ... }com.google.protobuf.UInt32Value getPerConnectionBufferLimitBytes()
Soft limit on size of the listener’s new connection read and write buffers. If unspecified, an implementation defined default is applied (1MiB).
.google.protobuf.UInt32Value per_connection_buffer_limit_bytes = 5 [(.udpa.annotations.security) = { ... }com.google.protobuf.UInt32ValueOrBuilder getPerConnectionBufferLimitBytesOrBuilder()
Soft limit on size of the listener’s new connection read and write buffers. If unspecified, an implementation defined default is applied (1MiB).
.google.protobuf.UInt32Value per_connection_buffer_limit_bytes = 5 [(.udpa.annotations.security) = { ... }boolean hasMetadata()
Listener metadata.
.envoy.config.core.v3.Metadata metadata = 6;Metadata getMetadata()
Listener metadata.
.envoy.config.core.v3.Metadata metadata = 6;MetadataOrBuilder getMetadataOrBuilder()
Listener metadata.
.envoy.config.core.v3.Metadata metadata = 6;@Deprecated boolean hasDeprecatedV1()
[#not-implemented-hide:]
.envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true];@Deprecated Listener.DeprecatedV1 getDeprecatedV1()
[#not-implemented-hide:]
.envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true];@Deprecated Listener.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()
[#not-implemented-hide:]
.envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true];int getDrainTypeValue()
The type of draining to perform at a listener-wide level.
.envoy.config.listener.v3.Listener.DrainType drain_type = 8;Listener.DrainType getDrainType()
The type of draining to perform at a listener-wide level.
.envoy.config.listener.v3.Listener.DrainType drain_type = 8;List<ListenerFilter> getListenerFiltersList()
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_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_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP <envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`. UDP listeners currently support a single filter.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;ListenerFilter getListenerFilters(int index)
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_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_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP <envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`. UDP listeners currently support a single filter.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;int getListenerFiltersCount()
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_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_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP <envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`. UDP listeners currently support a single filter.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;List<? extends ListenerFilterOrBuilder> getListenerFiltersOrBuilderList()
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_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_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP <envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`. UDP listeners currently support a single filter.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;ListenerFilterOrBuilder getListenerFiltersOrBuilder(int index)
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_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_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP <envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`. UDP listeners currently support a single filter.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;boolean hasListenerFiltersTimeout()
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.
.google.protobuf.Duration listener_filters_timeout = 15;com.google.protobuf.Duration getListenerFiltersTimeout()
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.
.google.protobuf.Duration listener_filters_timeout = 15;com.google.protobuf.DurationOrBuilder getListenerFiltersTimeoutOrBuilder()
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.
.google.protobuf.Duration listener_filters_timeout = 15;boolean getContinueOnListenerFiltersTimeout()
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.
bool continue_on_listener_filters_timeout = 17;boolean hasTransparent()
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_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.
.google.protobuf.BoolValue transparent = 10;com.google.protobuf.BoolValue getTransparent()
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_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.
.google.protobuf.BoolValue transparent = 10;com.google.protobuf.BoolValueOrBuilder getTransparentOrBuilder()
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_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.
.google.protobuf.BoolValue transparent = 10;boolean hasFreebind()
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.
.google.protobuf.BoolValue freebind = 11;com.google.protobuf.BoolValue getFreebind()
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.
.google.protobuf.BoolValue freebind = 11;com.google.protobuf.BoolValueOrBuilder getFreebindOrBuilder()
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.
.google.protobuf.BoolValue freebind = 11;List<SocketOption> getSocketOptionsList()
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;SocketOption getSocketOptions(int index)
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;int getSocketOptionsCount()
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;List<? extends SocketOptionOrBuilder> getSocketOptionsOrBuilderList()
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;SocketOptionOrBuilder getSocketOptionsOrBuilder(int index)
Additional socket options that may not be present in Envoy source code or precompiled binaries.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;boolean hasTcpFastOpenQueueLength()
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.
.google.protobuf.UInt32Value tcp_fast_open_queue_length = 12;com.google.protobuf.UInt32Value getTcpFastOpenQueueLength()
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.
.google.protobuf.UInt32Value tcp_fast_open_queue_length = 12;com.google.protobuf.UInt32ValueOrBuilder getTcpFastOpenQueueLengthOrBuilder()
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.
.google.protobuf.UInt32Value tcp_fast_open_queue_length = 12;int getTrafficDirectionValue()
Specifies the intended direction of the traffic relative to the local Envoy.
.envoy.config.core.v3.TrafficDirection traffic_direction = 16;TrafficDirection getTrafficDirection()
Specifies the intended direction of the traffic relative to the local Envoy.
.envoy.config.core.v3.TrafficDirection traffic_direction = 16;boolean hasUdpListenerConfig()
If the protocol in the listener socket address in :ref:`protocol <envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP <envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp listener to create, i.e. :ref:`udp_listener_name <envoy_api_field_config.listener.v3.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
.envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;UdpListenerConfig getUdpListenerConfig()
If the protocol in the listener socket address in :ref:`protocol <envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP <envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp listener to create, i.e. :ref:`udp_listener_name <envoy_api_field_config.listener.v3.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
.envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;UdpListenerConfigOrBuilder getUdpListenerConfigOrBuilder()
If the protocol in the listener socket address in :ref:`protocol <envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP <envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp listener to create, i.e. :ref:`udp_listener_name <envoy_api_field_config.listener.v3.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
.envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;boolean hasApiListener()
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_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.]
.envoy.config.listener.v3.ApiListener api_listener = 19;ApiListener getApiListener()
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_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.]
.envoy.config.listener.v3.ApiListener api_listener = 19;ApiListenerOrBuilder getApiListenerOrBuilder()
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_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.]
.envoy.config.listener.v3.ApiListener api_listener = 19;boolean hasConnectionBalanceConfig()
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.
.envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;Listener.ConnectionBalanceConfig getConnectionBalanceConfig()
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.
.envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;Listener.ConnectionBalanceConfigOrBuilder getConnectionBalanceConfigOrBuilder()
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.
.envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;boolean getReusePort()
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. Before Linux v4.19-rc1, new TCP connections may be rejected during hot restart (see `3rd paragraph in 'soreuseport' commit message <https://github.com/torvalds/linux/commit/c617f398edd4db2b8567a28e89>`_). This issue was fixed by `tcp: Avoid TCP syncookie rejected by SO_REUSEPORT socket <https://github.com/torvalds/linux/commit/40a1227ea845a37ab197dd1caffb60b047fa36b1>`_.
bool reuse_port = 21;List<AccessLog> getAccessLogList()
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;AccessLog getAccessLog(int index)
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;int getAccessLogCount()
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;AccessLogOrBuilder getAccessLogOrBuilder(int index)
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;boolean hasUdpWriterConfig()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
writer to create, i.e. :ref:`name <envoy_api_field_config.core.v3.TypedExtensionConfig.name>`
= "udp_default_writer" for creating a udp writer with writing in passthrough mode,
= "udp_gso_batch_writer" for creating a udp writer with writing in batch mode.
If not present, treat it as "udp_default_writer".
[#not-implemented-hide:]
.envoy.config.core.v3.TypedExtensionConfig udp_writer_config = 23;TypedExtensionConfig getUdpWriterConfig()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
writer to create, i.e. :ref:`name <envoy_api_field_config.core.v3.TypedExtensionConfig.name>`
= "udp_default_writer" for creating a udp writer with writing in passthrough mode,
= "udp_gso_batch_writer" for creating a udp writer with writing in batch mode.
If not present, treat it as "udp_default_writer".
[#not-implemented-hide:]
.envoy.config.core.v3.TypedExtensionConfig udp_writer_config = 23;TypedExtensionConfigOrBuilder getUdpWriterConfigOrBuilder()
If the protocol in the listener socket address in :ref:`protocol
<envoy_api_field_config.core.v3.SocketAddress.protocol>` is :ref:`UDP
<envoy_api_enum_value_config.core.v3.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
writer to create, i.e. :ref:`name <envoy_api_field_config.core.v3.TypedExtensionConfig.name>`
= "udp_default_writer" for creating a udp writer with writing in passthrough mode,
= "udp_gso_batch_writer" for creating a udp writer with writing in batch mode.
If not present, treat it as "udp_default_writer".
[#not-implemented-hide:]
.envoy.config.core.v3.TypedExtensionConfig udp_writer_config = 23;boolean hasTcpBacklogSize()
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.
.google.protobuf.UInt32Value tcp_backlog_size = 24;com.google.protobuf.UInt32Value getTcpBacklogSize()
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.
.google.protobuf.UInt32Value tcp_backlog_size = 24;com.google.protobuf.UInt32ValueOrBuilder getTcpBacklogSizeOrBuilder()
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.
.google.protobuf.UInt32Value tcp_backlog_size = 24;boolean hasBindToPort()
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_api_field_config.listener.v3.Listener.use_original_dst>` to true. Default is true.
.google.protobuf.BoolValue bind_to_port = 26;com.google.protobuf.BoolValue getBindToPort()
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_api_field_config.listener.v3.Listener.use_original_dst>` to true. Default is true.
.google.protobuf.BoolValue bind_to_port = 26;com.google.protobuf.BoolValueOrBuilder getBindToPortOrBuilder()
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_api_field_config.listener.v3.Listener.use_original_dst>` to true. Default is true.
.google.protobuf.BoolValue bind_to_port = 26;Copyright © 2018–2021 The Envoy Project. All rights reserved.