Package io.micronaut.websocket.annotation

Annotation Type WebSocketComponent

  • @Documented
@Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
public @interface WebSocketComponent
    Stereotype meta-annotation declared on both ServerWebSocket and ClientWebSocket.
    Since:
    1.0

    • Field Summary

      Fields 
      Modifier and Type Fields Description
      static java.lang.String DEFAULT_URI
      The default WebSocket URI.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String uri  
      java.lang.String value  
      WebSocketVersion version  

    • Field Detail

      • DEFAULT_URI

        static final java.lang.String DEFAULT_URI
        The default WebSocket URI.

    • Element Detail

      • value

        @AliasFor(member="uri")
java.lang.String value
        Returns:
        The URI of the action
        Default:
        "/ws"

      • uri

        @AliasFor(member="value")
java.lang.String uri
        Returns:
        The URI of the action
        Default:
        "/ws"

      • version

        WebSocketVersion version
        Returns:
        The WebSocket version to use to connect
        Default:
        io.micronaut.websocket.WebSocketVersion.V13