Annotation Interface SocketEndpoint.AliveCheck

Enclosing class:
SocketEndpoint
public static @interface SocketEndpoint.AliveCheck
Controls periodic keep-alive pings to detect inactive sessions.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    long
    pingDelay
    Interval between pings in timeUnit().
    long
    pingTimeout
    Time allowed to receive a pong after a ping.
    TimeUnit
    timeUnit
    Unit for ping intervals and timeouts.
    boolean
    value
    Whether the keep-alive mechanism is enabled.

  • Element Details

    • value

      boolean value
      Whether the keep-alive mechanism is enabled. Defaults to true.
      Default:
      true

    • timeUnit

      TimeUnit timeUnit
      Unit for ping intervals and timeouts.
      Default:
      SECONDS

    • pingDelay

      long pingDelay
      Interval between pings in timeUnit().
      Default:
      50L

    • pingTimeout

      long pingTimeout
      Time allowed to receive a pong after a ping. If exceeded, the session is closed.
      Default:
      20L