All Superinterfaces:
NamedService, ProtocolConfig, Prototype.Api
All Known Implementing Classes:
WsConfig.BuilderBase.WsConfigImpl

public interface WsConfig extends Prototype.Api
WebSocket protocol configuration.
See Also:
  • Method Details

    • builder

      static WsConfig.Builder builder()
      Create a new fluent API builder to customize configuration.
      Returns:
      a new builder
    • builder

      static WsConfig.Builder builder(WsConfig instance)
      Create a new fluent API builder from an existing instance.
      Parameters:
      instance - an existing instance used as a base for the builder
      Returns:
      a builder based on an instance
    • create

      static WsConfig create(Config config)
      Create a new instance from configuration.
      Parameters:
      config - used to configure the new instance
      Returns:
      a new instance configured from configuration
    • create

      static WsConfig create()
      Create a new instance with default values.
      Returns:
      a new instance
    • origins

      Set<String> origins()
      WebSocket origins.
      Returns:
      origins
    • type

      default String type()
      Protocol configuration type.
      Specified by:
      type in interface NamedService
      Returns:
      type of this configuration
    • name

      String name()
      Name of this configuration.
      Specified by:
      name in interface NamedService
      Returns:
      configuration name
    • maxFrameLength

      int maxFrameLength()
      Max WebSocket frame size supported by the server on a read operation. Default is 1 MB.
      Returns:
      max frame size to read