Package io.envoyproxy.envoy.extensions.upstreams.tcp.v3

Interface TcpProtocolOptionsOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getIdleTimeout()
    The idle timeout for the connection.
    com.google.protobuf.DurationOrBuilder
    getIdleTimeoutOrBuilder()
    The idle timeout for the connection.
    boolean
    hasIdleTimeout()
    The idle timeout for the connection.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasIdleTimeout

      boolean hasIdleTimeout()
       The idle timeout for the connection. The idle timeout is defined as the period in which
 the connection is not associated with a downstream connection. When the idle timeout is
 reached, the connection will be closed.

 If not set, the default idle timeout is 10 minutes. To disable idle timeouts, explicitly set this to 0.

 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
      .google.protobuf.Duration idle_timeout = 1;
      Returns:
      Whether the idleTimeout field is set.

    • getIdleTimeout

      com.google.protobuf.Duration getIdleTimeout()
       The idle timeout for the connection. The idle timeout is defined as the period in which
 the connection is not associated with a downstream connection. When the idle timeout is
 reached, the connection will be closed.

 If not set, the default idle timeout is 10 minutes. To disable idle timeouts, explicitly set this to 0.

 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
      .google.protobuf.Duration idle_timeout = 1;
      Returns:
      The idleTimeout.

    • getIdleTimeoutOrBuilder

      com.google.protobuf.DurationOrBuilder getIdleTimeoutOrBuilder()
       The idle timeout for the connection. The idle timeout is defined as the period in which
 the connection is not associated with a downstream connection. When the idle timeout is
 reached, the connection will be closed.

 If not set, the default idle timeout is 10 minutes. To disable idle timeouts, explicitly set this to 0.

 .. warning::
   Disabling this timeout has a highly likelihood of yielding connection leaks due to lost TCP
   FIN packets, etc.
      .google.protobuf.Duration idle_timeout = 1;