io.micronaut.websocket.annotation

Annotation Type ClientWebSocket

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

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

Since:

1.0

Author:

graemerocher

Optional Element Summary

Optional Elements

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

Element Detail

value

@AliasFor(member="uri") @AliasFor(annotation=WebSocketComponent.class,member="value") @AliasFor(annotation=WebSocketComponent.class,member="uri")
public abstract 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")
public abstract String uri

Returns:

The URI of the action

Default:

"/ws"

version

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

Returns:

The WebSocket version to use to connect

Default:

io.micronaut.websocket.WebSocketVersion.V13

subprotocol

public abstract String subprotocol

Returns:

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

Default:

""