Package io.envoyproxy.envoy.api.v2

Interface ListenerOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Listener, Listener.Builder
public interface ListenerOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      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;
      Returns:
      The name.

    • getNameBytes

      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;
      Returns:
      The bytes for name.

    • hasAddress

      boolean hasAddress()
       The address that the listener should listen on. In general, the address must be unique, though
 that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
 Linux as the actual port will be allocated by the OS.
      .envoy.api.v2.core.Address address = 2 [(.validate.rules) = { ... }
      Returns:
      Whether the address field is set.

    • getAddress

      Address getAddress()
       The address that the listener should listen on. In general, the address must be unique, though
 that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
 Linux as the actual port will be allocated by the OS.
      .envoy.api.v2.core.Address address = 2 [(.validate.rules) = { ... }
      Returns:
      The address.

    • getAddressOrBuilder

      AddressOrBuilder getAddressOrBuilder()
       The address that the listener should listen on. In general, the address must be unique, though
 that is governed by the bind rules of the OS. E.g., multiple listeners can listen on port 0 on
 Linux as the actual port will be allocated by the OS.
      .envoy.api.v2.core.Address address = 2 [(.validate.rules) = { ... }

    • getFilterChainsList

      List<FilterChain> getFilterChainsList()
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;

    • getFilterChains

      FilterChain getFilterChains(int index)
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;

    • getFilterChainsCount

      int getFilterChainsCount()
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;

    • getFilterChainsOrBuilderList

      List<? extends FilterChainOrBuilder> getFilterChainsOrBuilderList()
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;

    • getFilterChainsOrBuilder

      FilterChainOrBuilder getFilterChainsOrBuilder(int index)
       A list of filter chains to consider for this listener. The
 :ref:`FilterChain <envoy_api_msg_listener.FilterChain>` with the most specific
 :ref:`FilterChainMatch <envoy_api_msg_listener.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.api.v2.listener.FilterChain filter_chains = 3;

    • hasUseOriginalDst

      @Deprecated boolean hasUseOriginalDst()
      Deprecated.
      envoy.api.v2.Listener.use_original_dst is deprecated. See envoy/api/v2/listener.proto;l=112
       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.

 .. attention::

   This field is deprecated. Use :ref:`an original_dst <config_listener_filters_original_dst>`
   :ref:`listener filter <envoy_api_field_Listener.listener_filters>` instead.

   Note that hand off to another listener is *NOT* performed without this flag. Once
   :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>` is implemented this flag
   will be removed, as filter chain matching can be used to select a filter chain based on the
   restored destination address.
      .google.protobuf.BoolValue use_original_dst = 4 [deprecated = true];
      Returns:
      Whether the useOriginalDst field is set.

    • getUseOriginalDst

      @Deprecated com.google.protobuf.BoolValue getUseOriginalDst()
      Deprecated.
      envoy.api.v2.Listener.use_original_dst is deprecated. See envoy/api/v2/listener.proto;l=112
       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.

 .. attention::

   This field is deprecated. Use :ref:`an original_dst <config_listener_filters_original_dst>`
   :ref:`listener filter <envoy_api_field_Listener.listener_filters>` instead.

   Note that hand off to another listener is *NOT* performed without this flag. Once
   :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>` is implemented this flag
   will be removed, as filter chain matching can be used to select a filter chain based on the
   restored destination address.
      .google.protobuf.BoolValue use_original_dst = 4 [deprecated = true];
      Returns:
      The useOriginalDst.

    • getUseOriginalDstOrBuilder

      @Deprecated com.google.protobuf.BoolValueOrBuilder getUseOriginalDstOrBuilder()
      Deprecated.
       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.

 .. attention::

   This field is deprecated. Use :ref:`an original_dst <config_listener_filters_original_dst>`
   :ref:`listener filter <envoy_api_field_Listener.listener_filters>` instead.

   Note that hand off to another listener is *NOT* performed without this flag. Once
   :ref:`FilterChainMatch <envoy_api_msg_listener.FilterChainMatch>` is implemented this flag
   will be removed, as filter chain matching can be used to select a filter chain based on the
   restored destination address.
      .google.protobuf.BoolValue use_original_dst = 4 [deprecated = true];

    • hasPerConnectionBufferLimitBytes

      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;
      Returns:
      Whether the perConnectionBufferLimitBytes field is set.

    • getPerConnectionBufferLimitBytes

      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;
      Returns:
      The perConnectionBufferLimitBytes.

    • getPerConnectionBufferLimitBytesOrBuilder

      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;

    • hasMetadata

      boolean hasMetadata()
       Listener metadata.
      .envoy.api.v2.core.Metadata metadata = 6;
      Returns:
      Whether the metadata field is set.

    • getMetadata

      Metadata getMetadata()
       Listener metadata.
      .envoy.api.v2.core.Metadata metadata = 6;
      Returns:
      The metadata.

    • getMetadataOrBuilder

      MetadataOrBuilder getMetadataOrBuilder()
       Listener metadata.
      .envoy.api.v2.core.Metadata metadata = 6;

    • hasDeprecatedV1

      boolean hasDeprecatedV1()
       [#not-implemented-hide:]
      .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;
      Returns:
      Whether the deprecatedV1 field is set.

    • getDeprecatedV1

      Listener.DeprecatedV1 getDeprecatedV1()
       [#not-implemented-hide:]
      .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;
      Returns:
      The deprecatedV1.

    • getDeprecatedV1OrBuilder

      Listener.DeprecatedV1OrBuilder getDeprecatedV1OrBuilder()
       [#not-implemented-hide:]
      .envoy.api.v2.Listener.DeprecatedV1 deprecated_v1 = 7;

    • getDrainTypeValue

      int getDrainTypeValue()
       The type of draining to perform at a listener-wide level.
      .envoy.api.v2.Listener.DrainType drain_type = 8;
      Returns:
      The enum numeric value on the wire for drainType.

    • getDrainType

      Listener.DrainType getDrainType()
       The type of draining to perform at a listener-wide level.
      .envoy.api.v2.Listener.DrainType drain_type = 8;
      Returns:
      The drainType.

    • getListenerFiltersList

      List<ListenerFilter> getListenerFiltersList()
       Listener filters have the opportunity to manipulate and augment the connection metadata that
 is used in connection filter chain matching, for example. These filters are run before any in
 :ref:`filter_chains <envoy_api_field_Listener.filter_chains>`. Order matters as the
 filters are processed sequentially right after a socket has been accepted by the listener, and
 before a connection is created.
 UDP Listener filters can be specified when the protocol in the listener socket address in
 :ref:`protocol <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;

    • getListenerFilters

      ListenerFilter getListenerFilters(int index)
       Listener filters have the opportunity to manipulate and augment the connection metadata that
 is used in connection filter chain matching, for example. These filters are run before any in
 :ref:`filter_chains <envoy_api_field_Listener.filter_chains>`. Order matters as the
 filters are processed sequentially right after a socket has been accepted by the listener, and
 before a connection is created.
 UDP Listener filters can be specified when the protocol in the listener socket address in
 :ref:`protocol <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;

    • getListenerFiltersCount

      int getListenerFiltersCount()
       Listener filters have the opportunity to manipulate and augment the connection metadata that
 is used in connection filter chain matching, for example. These filters are run before any in
 :ref:`filter_chains <envoy_api_field_Listener.filter_chains>`. Order matters as the
 filters are processed sequentially right after a socket has been accepted by the listener, and
 before a connection is created.
 UDP Listener filters can be specified when the protocol in the listener socket address in
 :ref:`protocol <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;

    • getListenerFiltersOrBuilderList

      List<? extends ListenerFilterOrBuilder> getListenerFiltersOrBuilderList()
       Listener filters have the opportunity to manipulate and augment the connection metadata that
 is used in connection filter chain matching, for example. These filters are run before any in
 :ref:`filter_chains <envoy_api_field_Listener.filter_chains>`. Order matters as the
 filters are processed sequentially right after a socket has been accepted by the listener, and
 before a connection is created.
 UDP Listener filters can be specified when the protocol in the listener socket address in
 :ref:`protocol <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;

    • getListenerFiltersOrBuilder

      ListenerFilterOrBuilder getListenerFiltersOrBuilder(int index)
       Listener filters have the opportunity to manipulate and augment the connection metadata that
 is used in connection filter chain matching, for example. These filters are run before any in
 :ref:`filter_chains <envoy_api_field_Listener.filter_chains>`. Order matters as the
 filters are processed sequentially right after a socket has been accepted by the listener, and
 before a connection is created.
 UDP Listener filters can be specified when the protocol in the listener socket address in
 :ref:`protocol <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`.
 UDP listeners currently support a single filter.
      repeated .envoy.api.v2.listener.ListenerFilter listener_filters = 9;

    • hasListenerFiltersTimeout

      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;
      Returns:
      Whether the listenerFiltersTimeout field is set.

    • getListenerFiltersTimeout

      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;
      Returns:
      The listenerFiltersTimeout.

    • getListenerFiltersTimeoutOrBuilder

      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;

    • getContinueOnListenerFiltersTimeout

      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;
      Returns:
      The continueOnListenerFiltersTimeout.

    • hasTransparent

      boolean hasTransparent()
       Whether the listener should be set as a transparent socket.
 When this flag is set to true, connections can be redirected to the listener using an
 *iptables* *TPROXY* target, in which case the original source and destination addresses and
 ports are preserved on accepted connections. This flag should be used in combination with
 :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
 <envoy_api_field_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;
      Returns:
      Whether the transparent field is set.

    • getTransparent

      com.google.protobuf.BoolValue getTransparent()
       Whether the listener should be set as a transparent socket.
 When this flag is set to true, connections can be redirected to the listener using an
 *iptables* *TPROXY* target, in which case the original source and destination addresses and
 ports are preserved on accepted connections. This flag should be used in combination with
 :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
 <envoy_api_field_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;
      Returns:
      The transparent.

    • getTransparentOrBuilder

      com.google.protobuf.BoolValueOrBuilder getTransparentOrBuilder()
       Whether the listener should be set as a transparent socket.
 When this flag is set to true, connections can be redirected to the listener using an
 *iptables* *TPROXY* target, in which case the original source and destination addresses and
 ports are preserved on accepted connections. This flag should be used in combination with
 :ref:`an original_dst <config_listener_filters_original_dst>` :ref:`listener filter
 <envoy_api_field_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;

    • hasFreebind

      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;
      Returns:
      Whether the freebind field is set.

    • getFreebind

      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;
      Returns:
      The freebind.

    • getFreebindOrBuilder

      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;

    • getSocketOptionsList

      List<SocketOption> getSocketOptionsList()
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;

    • getSocketOptions

      SocketOption getSocketOptions(int index)
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;

    • getSocketOptionsCount

      int getSocketOptionsCount()
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;

    • getSocketOptionsOrBuilderList

      List<? extends SocketOptionOrBuilder> getSocketOptionsOrBuilderList()
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;

    • getSocketOptionsOrBuilder

      SocketOptionOrBuilder getSocketOptionsOrBuilder(int index)
       Additional socket options that may not be present in Envoy source code or
 precompiled binaries.
      repeated .envoy.api.v2.core.SocketOption socket_options = 13;

    • hasTcpFastOpenQueueLength

      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;
      Returns:
      Whether the tcpFastOpenQueueLength field is set.

    • getTcpFastOpenQueueLength

      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;
      Returns:
      The tcpFastOpenQueueLength.

    • getTcpFastOpenQueueLengthOrBuilder

      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;

    • getTrafficDirectionValue

      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.api.v2.core.TrafficDirection traffic_direction = 16;
      Returns:
      The enum numeric value on the wire for trafficDirection.

    • getTrafficDirection

      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.api.v2.core.TrafficDirection traffic_direction = 16;
      Returns:
      The trafficDirection.

    • hasUdpListenerConfig

      boolean hasUdpListenerConfig()
       If the protocol in the listener socket address in :ref:`protocol
 <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
 listener to create, i.e. :ref:`udp_listener_name
 <envoy_api_field_listener.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for
 creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
      .envoy.api.v2.listener.UdpListenerConfig udp_listener_config = 18;
      Returns:
      Whether the udpListenerConfig field is set.

    • getUdpListenerConfig

      UdpListenerConfig getUdpListenerConfig()
       If the protocol in the listener socket address in :ref:`protocol
 <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
 listener to create, i.e. :ref:`udp_listener_name
 <envoy_api_field_listener.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for
 creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
      .envoy.api.v2.listener.UdpListenerConfig udp_listener_config = 18;
      Returns:
      The udpListenerConfig.

    • getUdpListenerConfigOrBuilder

      UdpListenerConfigOrBuilder getUdpListenerConfigOrBuilder()
       If the protocol in the listener socket address in :ref:`protocol
 <envoy_api_field_core.SocketAddress.protocol>` is :ref:`UDP
 <envoy_api_enum_value_core.SocketAddress.Protocol.UDP>`, this field specifies the actual udp
 listener to create, i.e. :ref:`udp_listener_name
 <envoy_api_field_listener.UdpListenerConfig.udp_listener_name>` = "raw_udp_listener" for
 creating a packet-oriented UDP listener. If not present, treat it as "raw_udp_listener".
      .envoy.api.v2.listener.UdpListenerConfig udp_listener_config = 18;

    • hasApiListener

      boolean hasApiListener()
       Used to represent an API listener, which is used in non-proxy clients. The type of API
 exposed to the non-proxy application depends on the type of API listener.
 When this field is set, no other field except for :ref:`name<envoy_api_field_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.v2.ApiListener api_listener = 19;
      Returns:
      Whether the apiListener field is set.

    • getApiListener

      ApiListener getApiListener()
       Used to represent an API listener, which is used in non-proxy clients. The type of API
 exposed to the non-proxy application depends on the type of API listener.
 When this field is set, no other field except for :ref:`name<envoy_api_field_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.v2.ApiListener api_listener = 19;
      Returns:
      The apiListener.

    • getApiListenerOrBuilder

      ApiListenerOrBuilder getApiListenerOrBuilder()
       Used to represent an API listener, which is used in non-proxy clients. The type of API
 exposed to the non-proxy application depends on the type of API listener.
 When this field is set, no other field except for :ref:`name<envoy_api_field_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.v2.ApiListener api_listener = 19;

    • hasConnectionBalanceConfig

      boolean hasConnectionBalanceConfig()
       The listener's connection balancer configuration, currently only applicable to TCP listeners.
 If no configuration is specified, Envoy will not attempt to balance active connections between
 worker threads.
      .envoy.api.v2.Listener.ConnectionBalanceConfig connection_balance_config = 20;
      Returns:
      Whether the connectionBalanceConfig field is set.

    • getConnectionBalanceConfig

      Listener.ConnectionBalanceConfig getConnectionBalanceConfig()
       The listener's connection balancer configuration, currently only applicable to TCP listeners.
 If no configuration is specified, Envoy will not attempt to balance active connections between
 worker threads.
      .envoy.api.v2.Listener.ConnectionBalanceConfig connection_balance_config = 20;
      Returns:
      The connectionBalanceConfig.

    • getConnectionBalanceConfigOrBuilder

      Listener.ConnectionBalanceConfigOrBuilder getConnectionBalanceConfigOrBuilder()
       The listener's connection balancer configuration, currently only applicable to TCP listeners.
 If no configuration is specified, Envoy will not attempt to balance active connections between
 worker threads.
      .envoy.api.v2.Listener.ConnectionBalanceConfig connection_balance_config = 20;

    • getReusePort

      boolean getReusePort()
       When this flag is set to true, listeners set the *SO_REUSEPORT* socket option and
 create one socket for each worker thread. This makes inbound connections
 distribute among worker threads roughly evenly in cases where there are a high number
 of connections. When this flag is set to false, all worker threads share one socket.

 Before Linux v4.19-rc1, new TCP connections may be rejected during hot restart
 (see `3rd paragraph in 'soreuseport' commit message
 <https://github.com/torvalds/linux/commit/c617f398edd4db2b8567a28e89>`_).
 This issue was fixed by `tcp: Avoid TCP syncookie rejected by SO_REUSEPORT socket
 <https://github.com/torvalds/linux/commit/40a1227ea845a37ab197dd1caffb60b047fa36b1>`_.
      bool reuse_port = 21;
      Returns:
      The reusePort.

    • getAccessLogList

      List<AccessLog> getAccessLogList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;

    • getAccessLog

      AccessLog getAccessLog(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;

    • getAccessLogCount

      int getAccessLogCount()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;

    • getAccessLogOrBuilderList

      List<? extends AccessLogOrBuilder> getAccessLogOrBuilderList()
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;

    • getAccessLogOrBuilder

      AccessLogOrBuilder getAccessLogOrBuilder(int index)
       Configuration for :ref:`access logs <arch_overview_access_logs>`
 emitted by this listener.
      repeated .envoy.config.filter.accesslog.v2.AccessLog access_log = 22;