Class Listener
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.config.listener.v3.Listener
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,ListenerOrBuilder
,java.io.Serializable
public final class Listener extends com.google.protobuf.GeneratedMessage implements ListenerOrBuilder
[#next-free-field: 36]
Protobuf typeenvoy.config.listener.v3.Listener
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Listener.Builder
[#next-free-field: 36]static class
Listener.ConnectionBalanceConfig
Configuration for listener connection balancing.static interface
Listener.ConnectionBalanceConfigOrBuilder
static class
Listener.DeprecatedV1
[#not-implemented-hide:]static interface
Listener.DeprecatedV1OrBuilder
static class
Listener.DrainType
Protobuf enumenvoy.config.listener.v3.Listener.DrainType
static class
Listener.InternalListenerConfig
Configuration for envoy internal listener.static interface
Listener.InternalListenerConfigOrBuilder
static class
Listener.ListenerSpecifierCase
-
Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
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.java.util.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.java.util.List<? extends AccessLogOrBuilder>
getAccessLogOrBuilderList()
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.AdditionalAddress
getAdditionalAddresses(int index)
The additional addresses the listener should listen on.int
getAdditionalAddressesCount()
The additional addresses the listener should listen on.java.util.List<AdditionalAddress>
getAdditionalAddressesList()
The additional addresses the listener should listen on.AdditionalAddressOrBuilder
getAdditionalAddressesOrBuilder(int index)
The additional addresses the listener should listen on.java.util.List<? extends AdditionalAddressOrBuilder>
getAdditionalAddressesOrBuilderList()
The additional addresses the listener should listen on.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.boolean
getBypassOverloadManager()
Whether the listener bypasses configured overload manager actions.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.static Listener
getDefaultInstance()
Listener
getDefaultInstanceForType()
Listener.DeprecatedV1
getDeprecatedV1()
Deprecated.envoy.config.listener.v3.Listener.deprecated_v1 is deprecated.Listener.DeprecatedV1OrBuilder
getDeprecatedV1OrBuilder()
Deprecated.static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
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.boolean
getEnableMptcp()
Enable MPTCP (multi-path TCP) on this listener.com.google.protobuf.BoolValue
getEnableReusePort()
When this flag is set to true, listeners set the ``SO_REUSEPORT`` socket option and create one socket for each worker thread.com.google.protobuf.BoolValueOrBuilder
getEnableReusePortOrBuilder()
When this flag is set to true, listeners set the ``SO_REUSEPORT`` socket option and create one socket for each worker thread.Matcher
getFilterChainMatcher()
:ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the network properties.MatcherOrBuilder
getFilterChainMatcherOrBuilder()
:ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the network properties.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.java.util.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.java.util.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.boolean
getIgnoreGlobalConnLimit()
Whether the listener should limit connections based upon the value of :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`.Listener.InternalListenerConfig
getInternalListener()
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.Listener.InternalListenerConfigOrBuilder
getInternalListenerOrBuilder()
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.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.java.util.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.java.util.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.Listener.ListenerSpecifierCase
getListenerSpecifierCase()
com.google.protobuf.UInt32Value
getMaxConnectionsToAcceptPerSocketEvent()
The maximum number of connections to accept from the kernel per socket event.com.google.protobuf.UInt32ValueOrBuilder
getMaxConnectionsToAcceptPerSocketEventOrBuilder()
The maximum number of connections to accept from the kernel per socket event.Metadata
getMetadata()
Listener metadata.MetadataOrBuilder
getMetadataOrBuilder()
Listener metadata.java.lang.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.Parser<Listener>
getParserForType()
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()
Deprecated.envoy.config.listener.v3.Listener.reuse_port is deprecated.int
getSerializedSize()
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.java.util.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.java.util.List<? extends SocketOptionOrBuilder>
getSocketOptionsOrBuilderList()
Additional socket options that may not be present in Envoy source code or precompiled binaries.java.lang.String
getStatPrefix()
Optional prefix to use on listener stats.com.google.protobuf.ByteString
getStatPrefixBytes()
Optional prefix to use on listener stats.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_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.UdpListenerConfigOrBuilder
getUdpListenerConfigOrBuilder()
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.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.envoy.config.listener.v3.Listener.deprecated_v1 is deprecated.boolean
hasEnableReusePort()
When this flag is set to true, listeners set the ``SO_REUSEPORT`` socket option and create one socket for each worker thread.boolean
hasFilterChainMatcher()
:ref:`Matcher API <arch_overview_matching_listener>` resolving the filter chain name from the network properties.boolean
hasFreebind()
Whether the listener should set the ``IP_FREEBIND`` socket option.int
hashCode()
boolean
hasInternalListener()
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.boolean
hasListenerFiltersTimeout()
The timeout to wait for all listener filters to complete operation.boolean
hasMaxConnectionsToAcceptPerSocketEvent()
The maximum number of connections to accept from the kernel per socket event.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_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.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.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static Listener.Builder
newBuilder()
static Listener.Builder
newBuilder(Listener prototype)
Listener.Builder
newBuilderForType()
protected Listener.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Listener
parseDelimitedFrom(java.io.InputStream input)
static Listener
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Listener
parseFrom(byte[] data)
static Listener
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Listener
parseFrom(com.google.protobuf.ByteString data)
static Listener
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Listener
parseFrom(com.google.protobuf.CodedInputStream input)
static Listener
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Listener
parseFrom(java.io.InputStream input)
static Listener
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Listener
parseFrom(java.nio.ByteBuffer data)
static Listener
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Listener>
parser()
Listener.Builder
toBuilder()
void
writeTo(com.google.protobuf.CodedOutputStream output)
-
Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
-
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
listenerSpecifierCase_
private int listenerSpecifierCase_
-
listenerSpecifier_
private java.lang.Object listenerSpecifier_
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
- See Also:
- Constant Field Values
-
name_
private volatile java.lang.Object name_
-
ADDRESS_FIELD_NUMBER
public static final int ADDRESS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
address_
private Address address_
-
ADDITIONAL_ADDRESSES_FIELD_NUMBER
public static final int ADDITIONAL_ADDRESSES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
additionalAddresses_
private java.util.List<AdditionalAddress> additionalAddresses_
-
STAT_PREFIX_FIELD_NUMBER
public static final int STAT_PREFIX_FIELD_NUMBER
- See Also:
- Constant Field Values
-
statPrefix_
private volatile java.lang.Object statPrefix_
-
FILTER_CHAINS_FIELD_NUMBER
public static final int FILTER_CHAINS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
filterChains_
private java.util.List<FilterChain> filterChains_
-
FILTER_CHAIN_MATCHER_FIELD_NUMBER
public static final int FILTER_CHAIN_MATCHER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
filterChainMatcher_
private Matcher filterChainMatcher_
-
USE_ORIGINAL_DST_FIELD_NUMBER
public static final int USE_ORIGINAL_DST_FIELD_NUMBER
- See Also:
- Constant Field Values
-
useOriginalDst_
private com.google.protobuf.BoolValue useOriginalDst_
-
DEFAULT_FILTER_CHAIN_FIELD_NUMBER
public static final int DEFAULT_FILTER_CHAIN_FIELD_NUMBER
- See Also:
- Constant Field Values
-
defaultFilterChain_
private FilterChain defaultFilterChain_
-
PER_CONNECTION_BUFFER_LIMIT_BYTES_FIELD_NUMBER
public static final int PER_CONNECTION_BUFFER_LIMIT_BYTES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
perConnectionBufferLimitBytes_
private com.google.protobuf.UInt32Value perConnectionBufferLimitBytes_
-
METADATA_FIELD_NUMBER
public static final int METADATA_FIELD_NUMBER
- See Also:
- Constant Field Values
-
metadata_
private Metadata metadata_
-
DEPRECATED_V1_FIELD_NUMBER
public static final int DEPRECATED_V1_FIELD_NUMBER
- See Also:
- Constant Field Values
-
deprecatedV1_
private Listener.DeprecatedV1 deprecatedV1_
-
DRAIN_TYPE_FIELD_NUMBER
public static final int DRAIN_TYPE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
drainType_
private int drainType_
-
LISTENER_FILTERS_FIELD_NUMBER
public static final int LISTENER_FILTERS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
listenerFilters_
private java.util.List<ListenerFilter> listenerFilters_
-
LISTENER_FILTERS_TIMEOUT_FIELD_NUMBER
public static final int LISTENER_FILTERS_TIMEOUT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
listenerFiltersTimeout_
private com.google.protobuf.Duration listenerFiltersTimeout_
-
CONTINUE_ON_LISTENER_FILTERS_TIMEOUT_FIELD_NUMBER
public static final int CONTINUE_ON_LISTENER_FILTERS_TIMEOUT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
continueOnListenerFiltersTimeout_
private boolean continueOnListenerFiltersTimeout_
-
TRANSPARENT_FIELD_NUMBER
public static final int TRANSPARENT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
transparent_
private com.google.protobuf.BoolValue transparent_
-
FREEBIND_FIELD_NUMBER
public static final int FREEBIND_FIELD_NUMBER
- See Also:
- Constant Field Values
-
freebind_
private com.google.protobuf.BoolValue freebind_
-
SOCKET_OPTIONS_FIELD_NUMBER
public static final int SOCKET_OPTIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
socketOptions_
private java.util.List<SocketOption> socketOptions_
-
TCP_FAST_OPEN_QUEUE_LENGTH_FIELD_NUMBER
public static final int TCP_FAST_OPEN_QUEUE_LENGTH_FIELD_NUMBER
- See Also:
- Constant Field Values
-
tcpFastOpenQueueLength_
private com.google.protobuf.UInt32Value tcpFastOpenQueueLength_
-
TRAFFIC_DIRECTION_FIELD_NUMBER
public static final int TRAFFIC_DIRECTION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
trafficDirection_
private int trafficDirection_
-
UDP_LISTENER_CONFIG_FIELD_NUMBER
public static final int UDP_LISTENER_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
udpListenerConfig_
private UdpListenerConfig udpListenerConfig_
-
API_LISTENER_FIELD_NUMBER
public static final int API_LISTENER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
apiListener_
private ApiListener apiListener_
-
CONNECTION_BALANCE_CONFIG_FIELD_NUMBER
public static final int CONNECTION_BALANCE_CONFIG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
connectionBalanceConfig_
private Listener.ConnectionBalanceConfig connectionBalanceConfig_
-
REUSE_PORT_FIELD_NUMBER
public static final int REUSE_PORT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
reusePort_
private boolean reusePort_
-
ENABLE_REUSE_PORT_FIELD_NUMBER
public static final int ENABLE_REUSE_PORT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
enableReusePort_
private com.google.protobuf.BoolValue enableReusePort_
-
ACCESS_LOG_FIELD_NUMBER
public static final int ACCESS_LOG_FIELD_NUMBER
- See Also:
- Constant Field Values
-
accessLog_
private java.util.List<AccessLog> accessLog_
-
TCP_BACKLOG_SIZE_FIELD_NUMBER
public static final int TCP_BACKLOG_SIZE_FIELD_NUMBER
- See Also:
- Constant Field Values
-
tcpBacklogSize_
private com.google.protobuf.UInt32Value tcpBacklogSize_
-
MAX_CONNECTIONS_TO_ACCEPT_PER_SOCKET_EVENT_FIELD_NUMBER
public static final int MAX_CONNECTIONS_TO_ACCEPT_PER_SOCKET_EVENT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
maxConnectionsToAcceptPerSocketEvent_
private com.google.protobuf.UInt32Value maxConnectionsToAcceptPerSocketEvent_
-
BIND_TO_PORT_FIELD_NUMBER
public static final int BIND_TO_PORT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
bindToPort_
private com.google.protobuf.BoolValue bindToPort_
-
INTERNAL_LISTENER_FIELD_NUMBER
public static final int INTERNAL_LISTENER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ENABLE_MPTCP_FIELD_NUMBER
public static final int ENABLE_MPTCP_FIELD_NUMBER
- See Also:
- Constant Field Values
-
enableMptcp_
private boolean enableMptcp_
-
IGNORE_GLOBAL_CONN_LIMIT_FIELD_NUMBER
public static final int IGNORE_GLOBAL_CONN_LIMIT_FIELD_NUMBER
- See Also:
- Constant Field Values
-
ignoreGlobalConnLimit_
private boolean ignoreGlobalConnLimit_
-
BYPASS_OVERLOAD_MANAGER_FIELD_NUMBER
public static final int BYPASS_OVERLOAD_MANAGER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
bypassOverloadManager_
private boolean bypassOverloadManager_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final Listener DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<Listener> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage
-
getListenerSpecifierCase
public Listener.ListenerSpecifierCase getListenerSpecifierCase()
- Specified by:
getListenerSpecifierCase
in interfaceListenerOrBuilder
-
getName
public java.lang.String 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;
- Specified by:
getName
in interfaceListenerOrBuilder
- Returns:
- The name.
-
getNameBytes
public 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;
- Specified by:
getNameBytes
in interfaceListenerOrBuilder
- Returns:
- The bytes for name.
-
hasAddress
public 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. Required unless ``api_listener`` or ``listener_specifier`` is populated.
.envoy.config.core.v3.Address address = 2;
- Specified by:
hasAddress
in interfaceListenerOrBuilder
- Returns:
- Whether the address field is set.
-
getAddress
public 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. Required unless ``api_listener`` or ``listener_specifier`` is populated.
.envoy.config.core.v3.Address address = 2;
- Specified by:
getAddress
in interfaceListenerOrBuilder
- Returns:
- The address.
-
getAddressOrBuilder
public 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. Required unless ``api_listener`` or ``listener_specifier`` is populated.
.envoy.config.core.v3.Address address = 2;
- Specified by:
getAddressOrBuilder
in interfaceListenerOrBuilder
-
getAdditionalAddressesList
public java.util.List<AdditionalAddress> getAdditionalAddressesList()
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.
repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
- Specified by:
getAdditionalAddressesList
in interfaceListenerOrBuilder
-
getAdditionalAddressesOrBuilderList
public java.util.List<? extends AdditionalAddressOrBuilder> getAdditionalAddressesOrBuilderList()
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.
repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
- Specified by:
getAdditionalAddressesOrBuilderList
in interfaceListenerOrBuilder
-
getAdditionalAddressesCount
public int getAdditionalAddressesCount()
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.
repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
- Specified by:
getAdditionalAddressesCount
in interfaceListenerOrBuilder
-
getAdditionalAddresses
public AdditionalAddress getAdditionalAddresses(int index)
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.
repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
- Specified by:
getAdditionalAddresses
in interfaceListenerOrBuilder
-
getAdditionalAddressesOrBuilder
public AdditionalAddressOrBuilder getAdditionalAddressesOrBuilder(int index)
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.
repeated .envoy.config.listener.v3.AdditionalAddress additional_addresses = 33;
- Specified by:
getAdditionalAddressesOrBuilder
in interfaceListenerOrBuilder
-
getStatPrefix
public java.lang.String getStatPrefix()
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>.``.
string stat_prefix = 28;
- Specified by:
getStatPrefix
in interfaceListenerOrBuilder
- Returns:
- The statPrefix.
-
getStatPrefixBytes
public com.google.protobuf.ByteString getStatPrefixBytes()
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>.``.
string stat_prefix = 28;
- Specified by:
getStatPrefixBytes
in interfaceListenerOrBuilder
- Returns:
- The bytes for statPrefix.
-
getFilterChainsList
public java.util.List<FilterChain> getFilterChainsList()
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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
- Specified by:
getFilterChainsList
in interfaceListenerOrBuilder
-
getFilterChainsOrBuilderList
public java.util.List<? extends FilterChainOrBuilder> getFilterChainsOrBuilderList()
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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
- Specified by:
getFilterChainsOrBuilderList
in interfaceListenerOrBuilder
-
getFilterChainsCount
public int getFilterChainsCount()
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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
- Specified by:
getFilterChainsCount
in interfaceListenerOrBuilder
-
getFilterChains
public FilterChain getFilterChains(int index)
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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
- Specified by:
getFilterChains
in interfaceListenerOrBuilder
-
getFilterChainsOrBuilder
public FilterChainOrBuilder getFilterChainsOrBuilder(int index)
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>`.
repeated .envoy.config.listener.v3.FilterChain filter_chains = 3;
- Specified by:
getFilterChainsOrBuilder
in interfaceListenerOrBuilder
-
hasFilterChainMatcher
public boolean hasFilterChainMatcher()
: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.
.xds.type.matcher.v3.Matcher filter_chain_matcher = 32 [(.xds.annotations.v3.field_status) = { ... }
- Specified by:
hasFilterChainMatcher
in interfaceListenerOrBuilder
- Returns:
- Whether the filterChainMatcher field is set.
-
getFilterChainMatcher
public Matcher getFilterChainMatcher()
: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.
.xds.type.matcher.v3.Matcher filter_chain_matcher = 32 [(.xds.annotations.v3.field_status) = { ... }
- Specified by:
getFilterChainMatcher
in interfaceListenerOrBuilder
- Returns:
- The filterChainMatcher.
-
getFilterChainMatcherOrBuilder
public MatcherOrBuilder getFilterChainMatcherOrBuilder()
: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.
.xds.type.matcher.v3.Matcher filter_chain_matcher = 32 [(.xds.annotations.v3.field_status) = { ... }
- Specified by:
getFilterChainMatcherOrBuilder
in interfaceListenerOrBuilder
-
hasUseOriginalDst
public 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;
- Specified by:
hasUseOriginalDst
in interfaceListenerOrBuilder
- Returns:
- Whether the useOriginalDst field is set.
-
getUseOriginalDst
public 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;
- Specified by:
getUseOriginalDst
in interfaceListenerOrBuilder
- Returns:
- The useOriginalDst.
-
getUseOriginalDstOrBuilder
public 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;
- Specified by:
getUseOriginalDstOrBuilder
in interfaceListenerOrBuilder
-
hasDefaultFilterChain
public 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;
- Specified by:
hasDefaultFilterChain
in interfaceListenerOrBuilder
- Returns:
- Whether the defaultFilterChain field is set.
-
getDefaultFilterChain
public 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;
- Specified by:
getDefaultFilterChain
in interfaceListenerOrBuilder
- Returns:
- The defaultFilterChain.
-
getDefaultFilterChainOrBuilder
public 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;
- Specified by:
getDefaultFilterChainOrBuilder
in interfaceListenerOrBuilder
-
hasPerConnectionBufferLimitBytes
public 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) = { ... }
- Specified by:
hasPerConnectionBufferLimitBytes
in interfaceListenerOrBuilder
- Returns:
- Whether the perConnectionBufferLimitBytes field is set.
-
getPerConnectionBufferLimitBytes
public 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) = { ... }
- Specified by:
getPerConnectionBufferLimitBytes
in interfaceListenerOrBuilder
- Returns:
- The perConnectionBufferLimitBytes.
-
getPerConnectionBufferLimitBytesOrBuilder
public 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) = { ... }
- Specified by:
getPerConnectionBufferLimitBytesOrBuilder
in interfaceListenerOrBuilder
-
hasMetadata
public boolean hasMetadata()
Listener metadata.
.envoy.config.core.v3.Metadata metadata = 6;
- Specified by:
hasMetadata
in interfaceListenerOrBuilder
- Returns:
- Whether the metadata field is set.
-
getMetadata
public Metadata getMetadata()
Listener metadata.
.envoy.config.core.v3.Metadata metadata = 6;
- Specified by:
getMetadata
in interfaceListenerOrBuilder
- Returns:
- The metadata.
-
getMetadataOrBuilder
public MetadataOrBuilder getMetadataOrBuilder()
Listener metadata.
.envoy.config.core.v3.Metadata metadata = 6;
- Specified by:
getMetadataOrBuilder
in interfaceListenerOrBuilder
-
hasDeprecatedV1
@Deprecated public boolean hasDeprecatedV1()
Deprecated.envoy.config.listener.v3.Listener.deprecated_v1 is deprecated. See envoy/config/listener/v3/listener.proto;l=188[#not-implemented-hide:]
.envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Specified by:
hasDeprecatedV1
in interfaceListenerOrBuilder
- Returns:
- Whether the deprecatedV1 field is set.
-
getDeprecatedV1
@Deprecated public Listener.DeprecatedV1 getDeprecatedV1()
Deprecated.envoy.config.listener.v3.Listener.deprecated_v1 is deprecated. See envoy/config/listener/v3/listener.proto;l=188[#not-implemented-hide:]
.envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Specified by:
getDeprecatedV1
in interfaceListenerOrBuilder
- Returns:
- The deprecatedV1.
-
getDeprecatedV1OrBuilder
@Deprecated public Listener.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()
Deprecated.[#not-implemented-hide:]
.envoy.config.listener.v3.Listener.DeprecatedV1 deprecated_v1 = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Specified by:
getDeprecatedV1OrBuilder
in interfaceListenerOrBuilder
-
getDrainTypeValue
public int getDrainTypeValue()
The type of draining to perform at a listener-wide level.
.envoy.config.listener.v3.Listener.DrainType drain_type = 8;
- Specified by:
getDrainTypeValue
in interfaceListenerOrBuilder
- Returns:
- The enum numeric value on the wire for drainType.
-
getDrainType
public Listener.DrainType getDrainType()
The type of draining to perform at a listener-wide level.
.envoy.config.listener.v3.Listener.DrainType drain_type = 8;
- Specified by:
getDrainType
in interfaceListenerOrBuilder
- Returns:
- The drainType.
-
getListenerFiltersList
public java.util.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_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.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
- Specified by:
getListenerFiltersList
in interfaceListenerOrBuilder
-
getListenerFiltersOrBuilderList
public java.util.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_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.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
- Specified by:
getListenerFiltersOrBuilderList
in interfaceListenerOrBuilder
-
getListenerFiltersCount
public 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_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.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
- Specified by:
getListenerFiltersCount
in interfaceListenerOrBuilder
-
getListenerFilters
public 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_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.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
- Specified by:
getListenerFilters
in interfaceListenerOrBuilder
-
getListenerFiltersOrBuilder
public 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_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.
repeated .envoy.config.listener.v3.ListenerFilter listener_filters = 9;
- Specified by:
getListenerFiltersOrBuilder
in interfaceListenerOrBuilder
-
hasListenerFiltersTimeout
public 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;
- Specified by:
hasListenerFiltersTimeout
in interfaceListenerOrBuilder
- Returns:
- Whether the listenerFiltersTimeout field is set.
-
getListenerFiltersTimeout
public 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;
- Specified by:
getListenerFiltersTimeout
in interfaceListenerOrBuilder
- Returns:
- The listenerFiltersTimeout.
-
getListenerFiltersTimeoutOrBuilder
public 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;
- Specified by:
getListenerFiltersTimeoutOrBuilder
in interfaceListenerOrBuilder
-
getContinueOnListenerFiltersTimeout
public 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;
- Specified by:
getContinueOnListenerFiltersTimeout
in interfaceListenerOrBuilder
- Returns:
- The continueOnListenerFiltersTimeout.
-
hasTransparent
public 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_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.
.google.protobuf.BoolValue transparent = 10;
- Specified by:
hasTransparent
in interfaceListenerOrBuilder
- Returns:
- Whether the transparent field is set.
-
getTransparent
public 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_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.
.google.protobuf.BoolValue transparent = 10;
- Specified by:
getTransparent
in interfaceListenerOrBuilder
- Returns:
- The transparent.
-
getTransparentOrBuilder
public 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_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.
.google.protobuf.BoolValue transparent = 10;
- Specified by:
getTransparentOrBuilder
in interfaceListenerOrBuilder
-
hasFreebind
public 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;
- Specified by:
hasFreebind
in interfaceListenerOrBuilder
- Returns:
- Whether the freebind field is set.
-
getFreebind
public 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;
- Specified by:
getFreebind
in interfaceListenerOrBuilder
- Returns:
- The freebind.
-
getFreebindOrBuilder
public 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;
- Specified by:
getFreebindOrBuilder
in interfaceListenerOrBuilder
-
getSocketOptionsList
public java.util.List<SocketOption> getSocketOptionsList()
Additional socket options that may not be present in Envoy source code or precompiled binaries. The socket options can be updated for a listener when :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>` is ``true``. Otherwise, if socket options change during a listener update the update will be rejected to make it clear that the options were not updated.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;
- Specified by:
getSocketOptionsList
in interfaceListenerOrBuilder
-
getSocketOptionsOrBuilderList
public java.util.List<? extends SocketOptionOrBuilder> getSocketOptionsOrBuilderList()
Additional socket options that may not be present in Envoy source code or precompiled binaries. The socket options can be updated for a listener when :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>` is ``true``. Otherwise, if socket options change during a listener update the update will be rejected to make it clear that the options were not updated.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;
- Specified by:
getSocketOptionsOrBuilderList
in interfaceListenerOrBuilder
-
getSocketOptionsCount
public int getSocketOptionsCount()
Additional socket options that may not be present in Envoy source code or precompiled binaries. The socket options can be updated for a listener when :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>` is ``true``. Otherwise, if socket options change during a listener update the update will be rejected to make it clear that the options were not updated.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;
- Specified by:
getSocketOptionsCount
in interfaceListenerOrBuilder
-
getSocketOptions
public SocketOption getSocketOptions(int index)
Additional socket options that may not be present in Envoy source code or precompiled binaries. The socket options can be updated for a listener when :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>` is ``true``. Otherwise, if socket options change during a listener update the update will be rejected to make it clear that the options were not updated.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;
- Specified by:
getSocketOptions
in interfaceListenerOrBuilder
-
getSocketOptionsOrBuilder
public SocketOptionOrBuilder getSocketOptionsOrBuilder(int index)
Additional socket options that may not be present in Envoy source code or precompiled binaries. The socket options can be updated for a listener when :ref:`enable_reuse_port <envoy_v3_api_field_config.listener.v3.Listener.enable_reuse_port>` is ``true``. Otherwise, if socket options change during a listener update the update will be rejected to make it clear that the options were not updated.
repeated .envoy.config.core.v3.SocketOption socket_options = 13;
- Specified by:
getSocketOptionsOrBuilder
in interfaceListenerOrBuilder
-
hasTcpFastOpenQueueLength
public 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;
- Specified by:
hasTcpFastOpenQueueLength
in interfaceListenerOrBuilder
- Returns:
- Whether the tcpFastOpenQueueLength field is set.
-
getTcpFastOpenQueueLength
public 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;
- Specified by:
getTcpFastOpenQueueLength
in interfaceListenerOrBuilder
- Returns:
- The tcpFastOpenQueueLength.
-
getTcpFastOpenQueueLengthOrBuilder
public 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;
- Specified by:
getTcpFastOpenQueueLengthOrBuilder
in interfaceListenerOrBuilder
-
getTrafficDirectionValue
public int getTrafficDirectionValue()
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>`.
.envoy.config.core.v3.TrafficDirection traffic_direction = 16;
- Specified by:
getTrafficDirectionValue
in interfaceListenerOrBuilder
- Returns:
- The enum numeric value on the wire for trafficDirection.
-
getTrafficDirection
public TrafficDirection getTrafficDirection()
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>`.
.envoy.config.core.v3.TrafficDirection traffic_direction = 16;
- Specified by:
getTrafficDirection
in interfaceListenerOrBuilder
- Returns:
- The trafficDirection.
-
hasUdpListenerConfig
public boolean hasUdpListenerConfig()
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.
.envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;
- Specified by:
hasUdpListenerConfig
in interfaceListenerOrBuilder
- Returns:
- Whether the udpListenerConfig field is set.
-
getUdpListenerConfig
public UdpListenerConfig getUdpListenerConfig()
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.
.envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;
- Specified by:
getUdpListenerConfig
in interfaceListenerOrBuilder
- Returns:
- The udpListenerConfig.
-
getUdpListenerConfigOrBuilder
public UdpListenerConfigOrBuilder getUdpListenerConfigOrBuilder()
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.
.envoy.config.listener.v3.UdpListenerConfig udp_listener_config = 18;
- Specified by:
getUdpListenerConfigOrBuilder
in interfaceListenerOrBuilder
-
hasApiListener
public 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_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.]
.envoy.config.listener.v3.ApiListener api_listener = 19;
- Specified by:
hasApiListener
in interfaceListenerOrBuilder
- Returns:
- Whether the apiListener field is set.
-
getApiListener
public 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_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.]
.envoy.config.listener.v3.ApiListener api_listener = 19;
- Specified by:
getApiListener
in interfaceListenerOrBuilder
- Returns:
- The apiListener.
-
getApiListenerOrBuilder
public 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_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.]
.envoy.config.listener.v3.ApiListener api_listener = 19;
- Specified by:
getApiListenerOrBuilder
in interfaceListenerOrBuilder
-
hasConnectionBalanceConfig
public 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. 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.
.envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;
- Specified by:
hasConnectionBalanceConfig
in interfaceListenerOrBuilder
- Returns:
- Whether the connectionBalanceConfig field is set.
-
getConnectionBalanceConfig
public 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. 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.
.envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;
- Specified by:
getConnectionBalanceConfig
in interfaceListenerOrBuilder
- Returns:
- The connectionBalanceConfig.
-
getConnectionBalanceConfigOrBuilder
public 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. 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.
.envoy.config.listener.v3.Listener.ConnectionBalanceConfig connection_balance_config = 20;
- Specified by:
getConnectionBalanceConfigOrBuilder
in interfaceListenerOrBuilder
-
getReusePort
@Deprecated public boolean getReusePort()
Deprecated.envoy.config.listener.v3.Listener.reuse_port is deprecated. See envoy/config/listener/v3/listener.proto;l=312Deprecated. Use ``enable_reuse_port`` instead.
bool reuse_port = 21 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];
- Specified by:
getReusePort
in interfaceListenerOrBuilder
- Returns:
- The reusePort.
-
hasEnableReusePort
public boolean hasEnableReusePort()
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.
.google.protobuf.BoolValue enable_reuse_port = 29;
- Specified by:
hasEnableReusePort
in interfaceListenerOrBuilder
- Returns:
- Whether the enableReusePort field is set.
-
getEnableReusePort
public com.google.protobuf.BoolValue getEnableReusePort()
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.
.google.protobuf.BoolValue enable_reuse_port = 29;
- Specified by:
getEnableReusePort
in interfaceListenerOrBuilder
- Returns:
- The enableReusePort.
-
getEnableReusePortOrBuilder
public com.google.protobuf.BoolValueOrBuilder getEnableReusePortOrBuilder()
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.
.google.protobuf.BoolValue enable_reuse_port = 29;
- Specified by:
getEnableReusePortOrBuilder
in interfaceListenerOrBuilder
-
getAccessLogList
public java.util.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;
- Specified by:
getAccessLogList
in interfaceListenerOrBuilder
-
getAccessLogOrBuilderList
public java.util.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;
- Specified by:
getAccessLogOrBuilderList
in interfaceListenerOrBuilder
-
getAccessLogCount
public int getAccessLogCount()
Configuration for :ref:`access logs <arch_overview_access_logs>` emitted by this listener.
repeated .envoy.config.accesslog.v3.AccessLog access_log = 22;
- Specified by:
getAccessLogCount
in interfaceListenerOrBuilder
-
getAccessLog
public 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;
- Specified by:
getAccessLog
in interfaceListenerOrBuilder
-
getAccessLogOrBuilder
public 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;
- Specified by:
getAccessLogOrBuilder
in interfaceListenerOrBuilder
-
hasTcpBacklogSize
public 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;
- Specified by:
hasTcpBacklogSize
in interfaceListenerOrBuilder
- Returns:
- Whether the tcpBacklogSize field is set.
-
getTcpBacklogSize
public 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;
- Specified by:
getTcpBacklogSize
in interfaceListenerOrBuilder
- Returns:
- The tcpBacklogSize.
-
getTcpBacklogSizeOrBuilder
public 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;
- Specified by:
getTcpBacklogSizeOrBuilder
in interfaceListenerOrBuilder
-
hasMaxConnectionsToAcceptPerSocketEvent
public boolean hasMaxConnectionsToAcceptPerSocketEvent()
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.
.google.protobuf.UInt32Value max_connections_to_accept_per_socket_event = 34 [(.validate.rules) = { ... }
- Specified by:
hasMaxConnectionsToAcceptPerSocketEvent
in interfaceListenerOrBuilder
- Returns:
- Whether the maxConnectionsToAcceptPerSocketEvent field is set.
-
getMaxConnectionsToAcceptPerSocketEvent
public com.google.protobuf.UInt32Value getMaxConnectionsToAcceptPerSocketEvent()
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.
.google.protobuf.UInt32Value max_connections_to_accept_per_socket_event = 34 [(.validate.rules) = { ... }
- Specified by:
getMaxConnectionsToAcceptPerSocketEvent
in interfaceListenerOrBuilder
- Returns:
- The maxConnectionsToAcceptPerSocketEvent.
-
getMaxConnectionsToAcceptPerSocketEventOrBuilder
public com.google.protobuf.UInt32ValueOrBuilder getMaxConnectionsToAcceptPerSocketEventOrBuilder()
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.
.google.protobuf.UInt32Value max_connections_to_accept_per_socket_event = 34 [(.validate.rules) = { ... }
- Specified by:
getMaxConnectionsToAcceptPerSocketEventOrBuilder
in interfaceListenerOrBuilder
-
hasBindToPort
public 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_v3_api_field_config.listener.v3.Listener.use_original_dst>` to true. Default is true.
.google.protobuf.BoolValue bind_to_port = 26;
- Specified by:
hasBindToPort
in interfaceListenerOrBuilder
- Returns:
- Whether the bindToPort field is set.
-
getBindToPort
public 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_v3_api_field_config.listener.v3.Listener.use_original_dst>` to true. Default is true.
.google.protobuf.BoolValue bind_to_port = 26;
- Specified by:
getBindToPort
in interfaceListenerOrBuilder
- Returns:
- The bindToPort.
-
getBindToPortOrBuilder
public 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_v3_api_field_config.listener.v3.Listener.use_original_dst>` to true. Default is true.
.google.protobuf.BoolValue bind_to_port = 26;
- Specified by:
getBindToPortOrBuilder
in interfaceListenerOrBuilder
-
hasInternalListener
public boolean hasInternalListener()
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>`
.envoy.config.listener.v3.Listener.InternalListenerConfig internal_listener = 27;
- Specified by:
hasInternalListener
in interfaceListenerOrBuilder
- Returns:
- Whether the internalListener field is set.
-
getInternalListener
public Listener.InternalListenerConfig getInternalListener()
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>`
.envoy.config.listener.v3.Listener.InternalListenerConfig internal_listener = 27;
- Specified by:
getInternalListener
in interfaceListenerOrBuilder
- Returns:
- The internalListener.
-
getInternalListenerOrBuilder
public Listener.InternalListenerConfigOrBuilder getInternalListenerOrBuilder()
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>`
.envoy.config.listener.v3.Listener.InternalListenerConfig internal_listener = 27;
- Specified by:
getInternalListenerOrBuilder
in interfaceListenerOrBuilder
-
getEnableMptcp
public boolean getEnableMptcp()
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.
bool enable_mptcp = 30;
- Specified by:
getEnableMptcp
in interfaceListenerOrBuilder
- Returns:
- The enableMptcp.
-
getIgnoreGlobalConnLimit
public boolean getIgnoreGlobalConnLimit()
Whether the listener should limit connections based upon the value of :ref:`global_downstream_max_connections <config_overload_manager_limiting_connections>`.
bool ignore_global_conn_limit = 31;
- Specified by:
getIgnoreGlobalConnLimit
in interfaceListenerOrBuilder
- Returns:
- The ignoreGlobalConnLimit.
-
getBypassOverloadManager
public boolean getBypassOverloadManager()
Whether the listener bypasses configured overload manager actions.
bool bypass_overload_manager = 35;
- Specified by:
getBypassOverloadManager
in interfaceListenerOrBuilder
- Returns:
- The bypassOverloadManager.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Listener parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Listener parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Listener parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Listener parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Listener parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Listener parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Listener parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Listener parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Listener parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Listener parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Listener parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Listener parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Listener.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Listener.Builder newBuilder()
-
newBuilder
public static Listener.Builder newBuilder(Listener prototype)
-
toBuilder
public Listener.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Listener.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static Listener getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Listener> parser()
-
getParserForType
public com.google.protobuf.Parser<Listener> getParserForType()
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public Listener getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-