Class JDKWSOptions

java.lang.Object
org.eclipse.net4j.ws.jdk.JDKWSOptions

public final class JDKWSOptions extends Object
Immutable connection settings for a JDK WebSocket provider factory.

The defaults are a ten-second opening-handshake timeout, a twenty-second heartbeat interval, and a maximum complete WebSocket message size of Short.MAX_VALUE bytes. The message-size limit includes the Net4j frame header.

Since:
2.0
Author:
Eike Stepper
  • Method Details

    • defaults

      public static JDKWSOptions defaults()
      Returns the defaults used by the original JDK provider overloads.
      Returns:
      immutable default options
    • builder

      public static JDKWSOptions.Builder builder()
      Creates a builder initialized with provider defaults.
      Returns:
      a new options builder
    • getWebSocketConnectTimeout

      public Duration getWebSocketConnectTimeout()
      Returns the maximum time allowed for a WebSocket opening handshake.
      Returns:
      opening-handshake timeout
    • getHeartbeatInterval

      public Duration getHeartbeatInterval()
      Returns the interval between unsolicited heartbeat Pong frames.
      Returns:
      heartbeat interval
    • getMaxMessageSize

      public int getMaxMessageSize()
      Returns the maximum complete WebSocket message size, including the Net4j frame header.
      Returns:
      message-size limit in bytes