Package io.micronaut.websocket.annotation

Annotation Interface ClientWebSocket

@Documented
@Retention(RUNTIME)
@Target({TYPE,ANNOTATION_TYPE})
@WebSocketComponent
@Introduction(interfaces=WebSocketSessionAware.class)
@Type(ClientWebSocketInterceptor.class)
@DefaultScope(io.micronaut.context.annotation.Prototype.class)
public @interface ClientWebSocket

Annotation declared on the client to indicate the class handles web socket frames.

Since:

1.0

Optional Element Summary

Optional Elements

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

Element Details

value

@AliasFor(member="uri") @AliasFor(annotation=WebSocketComponent.class,member="value") @AliasFor(annotation=WebSocketComponent.class,member="uri")
String value

Returns:

The URI of the action

Default:

"/ws"

uri

@AliasFor(member="value") @AliasFor(annotation=WebSocketComponent.class,member="value") @AliasFor(annotation=WebSocketComponent.class,member="uri")
String uri

Returns:

The URI of the action

Default:

"/ws"

version

@AliasFor(annotation=WebSocketComponent.class,
          member="version")
WebSocketVersion version

Returns:

The WebSocket version to use to connect

Default:

V13

subprotocol

String subprotocol

Returns:

The Sec-WebSocket-Protocol header field is used in the WebSocket opening handshake.

Default:

""