Class NettyConfig

  • All Implemented Interfaces:
    io.deephaven.server.config.ServerConfig

    @Immutable
    public abstract class NettyConfig
    extends java.lang.Object
    implements io.deephaven.server.config.ServerConfig
    The netty server configuration.
    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static interface  NettyConfig.Builder  
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DEFAULT_PLAINTEXT_PORT  
      static int DEFAULT_SSL_PORT  
      • Fields inherited from interface io.deephaven.server.config.ServerConfig

        DEFAULT_MAX_INBOUND_MESSAGE_SIZE_MiB, DEFAULT_SCHEDULER_POOL_SIZE, DEFAULT_TOKEN_EXPIRE_MIN, GRPC_MAX_INBOUND_MESSAGE_SIZE, HTTP_HOST, HTTP_PORT, HTTP_SESSION_DURATION_MS, HTTP_TARGET_URL, PROXY_HINT, SCHEDULER_POOL_SIZE
    • Constructor Summary

      Constructors 
      Constructor Description
      NettyConfig()  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static NettyConfig.Builder builder()  
      static NettyConfig.Builder buildFromConfig​(io.deephaven.configuration.Configuration config)
      Parses the configuration values into the appropriate builder methods via ServerConfig.buildFromConfig(ServerConfig.Builder, Configuration).
      static NettyConfig defaultConfig()
      The default configuration is suitable for local development purposes.
      int port()
      The port.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface io.deephaven.server.config.ServerConfig

        host, maxInboundMessageSize, outboundSsl, proxyHint, schedulerPoolSize, ssl, targetUrl, targetUrlOrDefault, tokenExpire
    • Constructor Detail

      • NettyConfig

        public NettyConfig()
    • Method Detail

      • defaultConfig

        public static NettyConfig defaultConfig()
        The default configuration is suitable for local development purposes. It inherits all of the defaults, which are documented on each individual method. In brief, the default server starts up on all interfaces with plaintext port 8080, a token expiration duration of 5 minutes, a scheduler pool size of 4, and a max inbound message size of 100 MiB.
      • buildFromConfig

        public static NettyConfig.Builder buildFromConfig​(io.deephaven.configuration.Configuration config)
        Parses the configuration values into the appropriate builder methods via ServerConfig.buildFromConfig(ServerConfig.Builder, Configuration).
        Parameters:
        config - the config
        Returns:
        the builder
      • port

        @Default
        public int port()
        The port. Defaults to 443 if ServerConfig.ssl() is present, otherwise defaults to 8080.
        Specified by:
        port in interface io.deephaven.server.config.ServerConfig