Class EndpointConfig

java.lang.Object
io.vertx.core.net.EndpointConfig
Direct Known Subclasses:
QuicEndpointConfig, TcpEndpointConfig
@Unstable public abstract class EndpointConfig extends Object
Configuration of an endpoint.
Author:
Julien Viet

  • Constructor Details

  • Method Details

    • getTransportConfig

      public abstract TransportConfig getTransportConfig()
      Returns:
      the endpoint transport config

    • setIdleTimeout

      public EndpointConfig setIdleTimeout(Duration idleTimeout)
      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.
      Parameters:
      idleTimeout - the idle timeout
      Returns:
      a reference to this, so the API can be used fluently

    • getIdleTimeout

      public Duration getIdleTimeout()
      Returns:
      the idle timeout applied to each stream

    • setReadIdleTimeout

      public EndpointConfig setReadIdleTimeout(Duration idleTimeout)

      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.

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

    • getReadIdleTimeout

      public Duration getReadIdleTimeout()
      Returns:
      the read idle timeout applied to each stream

    • setWriteIdleTimeout

      public EndpointConfig setWriteIdleTimeout(Duration idleTimeout)

      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.

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

    • getWriteIdleTimeout

      public Duration getWriteIdleTimeout()
      Returns:
      the write idle timeout applied to each stream

    • getMetricsName

      public String getMetricsName()
      Returns:
      the metrics name identifying the reported metrics.

    • setMetricsName

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

    • getLogConfig

      public LogConfig getLogConfig()
      Returns:
      the log config

    • setLogConfig

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