Package io.fluxcapacitor.javaclient.web

Annotation Interface SocketEndpoint

@Documented @Target(TYPE) @Retention(RUNTIME) @Inherited @Component @Scope("prototype") public @interface SocketEndpoint
Declares a WebSocket endpoint that represents a single active client session.

This annotation is used on handler classes with annotations like HandleSocketMessage that manage WebSocket communication and lifecycle events (e.g. handshake, open, message, close).

Socket endpoint beans are prototype-scoped, meaning a new instance is created per WebSocket session.

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    SocketEndpoint.AliveCheck
    Controls periodic keep-alive pings to detect inactive sessions.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    SocketEndpoint.AliveCheck
    aliveCheck
    Configures the WebSocket session keep-alive mechanism (ping/pong).

  • Element Details

    • aliveCheck

      SocketEndpoint.AliveCheck aliveCheck
      Configures the WebSocket session keep-alive mechanism (ping/pong).
      Default:
      @io.fluxcapacitor.javaclient.web.SocketEndpoint.AliveCheck