Package io.micronaut.websocket.annotation

Annotation Interface WebSocketComponent

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

Stereotype meta-annotation declared on both ServerWebSocket and ClientWebSocket.

Since:

1.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	uri
String	value
WebSocketVersion	version

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_URI	The default WebSocket URI.

Field Details

DEFAULT_URI

static final String DEFAULT_URI

The default WebSocket URI.

See Also:

• Constant Field Values

Element Details

value

@AliasFor(member="uri")
String value

Returns:

The URI of the action

Default:

"/ws"

uri

@AliasFor(member="value")
String uri

Returns:

The URI of the action

Default:

"/ws"

version

WebSocketVersion version

Returns:

The WebSocket version to use to connect

Default:

V13