Class TcpEndpointConfig

java.lang.Object
io.vertx.core.net.EndpointConfig
io.vertx.core.net.TcpEndpointConfig
Direct Known Subclasses:
TcpClientConfig, TcpServerConfig
@Unstable public abstract class TcpEndpointConfig extends EndpointConfig
Should this be TcpConfig instead ?
Author:
Julien Viet

  • Constructor Details

    • TcpEndpointConfig

      public TcpEndpointConfig()

    • TcpEndpointConfig

      public TcpEndpointConfig(TcpEndpointConfig other)

    • TcpEndpointConfig

      public TcpEndpointConfig(TCPSSLOptions options)

  • Method Details

    • getTransportConfig

      public TcpConfig getTransportConfig()
      Specified by:
      getTransportConfig in class EndpointConfig
      Returns:
      the client TCP transport options

    • setTransportConfig

      public TcpEndpointConfig setTransportConfig(TcpConfig transportConfig)
      Set the client TCP transport config.
      Parameters:
      transportConfig - the transport config
      Returns:
      a reference to this, so the API can be used fluently

    • isSsl

      public boolean isSsl()
      Returns:
      is SSL/TLS enabled?

    • setSsl

      public TcpEndpointConfig setSsl(boolean ssl)
      Set whether SSL/TLS is enabled
      Parameters:
      ssl - true if enabled
      Returns:
      a reference to this, so the API can be used fluently

    • setIdleTimeout

      public TcpEndpointConfig setIdleTimeout(Duration idleTimeout)
      Description copied from class: EndpointConfig
      Set the stream idle timeout, zero or null means don't time out. This determines if a stream will timeout and be closed if no data is received nor sent within the timeout.
      Overrides:
      setIdleTimeout in class EndpointConfig
      Parameters:
      idleTimeout - the idle timeout
      Returns:
      a reference to this, so the API can be used fluently

    • setReadIdleTimeout

      public TcpEndpointConfig setReadIdleTimeout(Duration idleTimeout)
      Description copied from class: EndpointConfig

      Set the stream read idle timeout, zero or null means or null means don't time out. This determines if a stream will timeout and be closed if no data is received within the timeout.

      Overrides:
      setReadIdleTimeout in class EndpointConfig
      Parameters:
      idleTimeout - the read idle timeout
      Returns:
      a reference to this, so the API can be used fluently

    • setWriteIdleTimeout

      public TcpEndpointConfig setWriteIdleTimeout(Duration idleTimeout)
      Description copied from class: EndpointConfig

      Set the stream write idle timeout, zero or null means don't time out. This determines if a stream will timeout and be closed if no data is sent within the timeout.

      Overrides:
      setWriteIdleTimeout in class EndpointConfig
      Parameters:
      idleTimeout - the write idle timeout
      Returns:
      a reference to this, so the API can be used fluently

    • setMetricsName

      public TcpEndpointConfig setMetricsName(String metricsName)
      Description copied from class: EndpointConfig
      Set the metrics name identifying the reported metrics, useful for grouping metrics with the same name.
      Overrides:
      setMetricsName in class EndpointConfig
      Parameters:
      metricsName - the metrics name
      Returns:
      a reference to this, so the API can be used fluently

    • setLogConfig

      public TcpEndpointConfig setLogConfig(LogConfig config)
      Description copied from class: EndpointConfig
      Configure the log config: Netty's stream pipeline is configured for logging on Netty's logger.
      Overrides:
      setLogConfig in class EndpointConfig
      Parameters:
      config - the log config
      Returns:
      a reference to this, so the API can be used fluently