Module io.helidon.webserver.websocket
Package io.helidon.webserver.websocket

Interface WsRouteRegistration

@Contract public interface WsRouteRegistration
A contract for generated web socket registrations.

The implementing types are expected to be ServiceRegistry services, and will be loaded through a ServerFeature.

  • Method Summary

    Modifier and Type
    Method
    Description
    WsRoute
    route()
    WebSocket route provided by this registration.
    default String
    socket()
    Named socket this registration should be added to.
    default boolean
    socketRequired()
    Whether the socket defined in socket() must be present for this registration, or it can be exposed on default socket.

  • Method Details

    • route

      WsRoute route()
      WebSocket route provided by this registration.
      Returns:
      the route

    • socket

      default String socket()
      Named socket this registration should be added to.
      Returns:
      name of the socket

    • socketRequired

      default boolean socketRequired()
      Whether the socket defined in socket() must be present for this registration, or it can be exposed on default socket.
      Returns:
      true if this registration must be exposed on the named socket, false by default