io.micronaut.websocket.annotation

Annotation Type WebSocketComponent

@Documented
 @Retention(value=RUNTIME)
 @Target(value=ANNOTATION_TYPE)
public @interface WebSocketComponent

Stereotype meta-annotation declared on both ServerWebSocket and ClientWebSocket.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

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

Optional Element Summary

Optional Elements

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

Field Detail

DEFAULT_URI

public static final java.lang.String DEFAULT_URI

The default WebSocket URI.

Element Detail

value

@AliasFor(member="uri")
public abstract java.lang.String value

Returns:

The URI of the action

Default:

"/ws"

uri

@AliasFor(member="value")
public abstract java.lang.String uri

Returns:

The URI of the action

Default:

"/ws"

version

public abstract WebSocketVersion version

Returns:

The WebSocket version to use to connect

Default:

io.micronaut.websocket.WebSocketVersion.V13