Index (websocket 3.5.1 API)

A B C D E F G H I M N O P R S T U V W

A

ABNORMAL_CLOSURE - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
addRequestArgumentBinder(ArgumentBinder<T, ST>) - Method in class io.micronaut.websocket.bind.WebSocketStateBinderRegistry

B

BAD_GATEWAY - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
broadcast(T, MediaType, Predicate<WebSocketSession>) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections that match the given filter.
broadcast(T, MediaType) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections.
broadcast(T) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections.
broadcast(T, Predicate<WebSocketSession>) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections that match the given filter.
broadcastAsync(T, MediaType, Predicate<WebSocketSession>) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections.
broadcastAsync(T) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections.
broadcastAsync(T, Predicate<WebSocketSession>) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections that match the given filter.
broadcastAsync(T, MediaType) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections.
broadcastSync(T, MediaType, Predicate<WebSocketSession>) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections.
broadcastSync(T) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections.
broadcastSync(T, Predicate<WebSocketSession>) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections that match the given filter.
broadcastSync(T, MediaType) - Method in interface io.micronaut.websocket.WebSocketBroadcaster: When used on the server this method will broadcast a message to all open WebSocket connections.

C

ClientWebSocket - Annotation Type in io.micronaut.websocket.annotation: Annotation declared on the client to indicate the class handles web socket frames.
ClientWebSocketInterceptor - Class in io.micronaut.websocket.interceptor: Intercepts unimplemented ClientWebSocket methods.
ClientWebSocketInterceptor() - Constructor for class io.micronaut.websocket.interceptor.ClientWebSocketInterceptor
close() - Method in interface io.micronaut.websocket.WebSocketClient
close() - Method in interface io.micronaut.websocket.WebSocketSession
close(CloseReason) - Method in interface io.micronaut.websocket.WebSocketSession: Close the session with the given event.
closeMethod() - Method in interface io.micronaut.websocket.context.WebSocketBean: Returns the method annotated with OnClose.
CloseReason - Class in io.micronaut.websocket: Enumeration of close events.
CloseReason(int, String) - Constructor for class io.micronaut.websocket.CloseReason: Default constructor.
connect(Class<T>, MutableHttpRequest<?>) - Method in interface io.micronaut.websocket.WebSocketClient: Connect the given client endpoint type to the URI over WebSocket.
connect(Class<T>, Map<String, Object>) - Method in interface io.micronaut.websocket.WebSocketClient: Connect the given client endpoint type.
connect(Class<T>, String) - Method in interface io.micronaut.websocket.WebSocketClient: Connect the given client endpoint type to the URI over WebSocket.
connect(Class<T>, URI) - Method in interface io.micronaut.websocket.WebSocketClient: Connect the given client endpoint type to the URI over WebSocket.
create(URL) - Static method in interface io.micronaut.websocket.WebSocketClient: Deprecated.
Use WebSocketClient.create(URI) instead
create(URL, HttpClientConfiguration) - Static method in interface io.micronaut.websocket.WebSocketClient: Deprecated.
Use WebSocketClient.create(URI, HttpClientConfiguration) instead
create(URI) - Static method in interface io.micronaut.websocket.WebSocketClient: Create a new WebSocketClient.
create(URI, HttpClientConfiguration) - Static method in interface io.micronaut.websocket.WebSocketClient: Create a new WebSocketClient with the specified configuration.
createWebSocketClient(URL) - Method in interface io.micronaut.websocket.WebSocketClientFactory: Deprecated.
Use WebSocketClientFactory.createWebSocketClient(URI) instead
createWebSocketClient(URL, HttpClientConfiguration) - Method in interface io.micronaut.websocket.WebSocketClientFactory: Deprecated.
Use WebSocketClientFactory.createWebSocketClient(URI, HttpClientConfiguration) instead
createWebSocketClient(URI) - Method in interface io.micronaut.websocket.WebSocketClientFactory: Create a new WebSocketClient.
createWebSocketClient(URI, HttpClientConfiguration) - Method in interface io.micronaut.websocket.WebSocketClientFactory: Create a new WebSocketClient with the specified configuration.

D

DEFAULT_URI - Static variable in annotation type io.micronaut.websocket.annotation.WebSocketComponent: The default WebSocket URI.
disposeClient(AnnotationMetadata) - Method in interface io.micronaut.websocket.WebSocketClientRegistry: Dispose of the client defined by the given metadata.

E

EMPTY - Static variable in interface io.micronaut.websocket.context.WebSocketBeanRegistry: An empty registry.
equals(Object) - Method in class io.micronaut.websocket.CloseReason
errorMethod() - Method in interface io.micronaut.websocket.context.WebSocketBean: Returns the method annotated with OnError.

F

findArgumentBinder(Argument<T>, WebSocketState) - Method in class io.micronaut.websocket.bind.WebSocketStateBinderRegistry
forClient(BeanContext) - Static method in interface io.micronaut.websocket.context.WebSocketBeanRegistry: Create a WebSocketBeanRegistry from the given bean context.
forServer(BeanContext) - Static method in interface io.micronaut.websocket.context.WebSocketBeanRegistry: Create a WebSocketBeanRegistry from the given bean context.

G

getAttributes() - Method in interface io.micronaut.websocket.WebSocketSession
getBeanDefinition() - Method in interface io.micronaut.websocket.context.WebSocketBean: The bean definition.
getCode() - Method in class io.micronaut.websocket.CloseReason
getContent() - Method in class io.micronaut.websocket.WebSocketPongMessage
getDefaultWebSocketClient() - Method in interface io.micronaut.websocket.WebSocketClientRegistry
getId() - Method in interface io.micronaut.websocket.WebSocketSession: The ID of the session.
getMessage() - Method in class io.micronaut.websocket.event.WebSocketMessageProcessedEvent
getOpenSessions() - Method in interface io.micronaut.websocket.WebSocketSession: The current open sessions.
getOriginatingRequest() - Method in class io.micronaut.websocket.bind.WebSocketState
getProtocolVersion() - Method in interface io.micronaut.websocket.WebSocketSession: The protocol version of the WebSocket protocol currently being used.
getReason() - Method in class io.micronaut.websocket.CloseReason
getRequestParameters() - Method in interface io.micronaut.websocket.WebSocketSession: The request parameters used to create this session.
getRequestURI() - Method in interface io.micronaut.websocket.WebSocketSession: The request URI this session was opened under.
getSession() - Method in class io.micronaut.websocket.bind.WebSocketState
getSource() - Method in class io.micronaut.websocket.event.WebSocketEvent
getSubprotocol() - Method in interface io.micronaut.websocket.WebSocketSession: The subprotocol if one is used.
getTarget() - Method in interface io.micronaut.websocket.context.WebSocketBean
getUriVariables() - Method in interface io.micronaut.websocket.WebSocketSession: Any matching URI path variables.
getUserPrincipal() - Method in interface io.micronaut.websocket.WebSocketSession: The user Principal used to create the session.
getWebSocket(Class<T>) - Method in interface io.micronaut.websocket.context.WebSocketBeanRegistry: Retrieves a WebSocketBean.
getWebSocketClient(AnnotationMetadata) - Method in interface io.micronaut.websocket.WebSocketClientRegistry: Return the client for the given annotation metadata.
GOING_AWAY - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.

H

hashCode() - Method in class io.micronaut.websocket.CloseReason

I

intercept(MethodInvocationContext<Object, Object>) - Method in class io.micronaut.websocket.interceptor.ClientWebSocketInterceptor
INTERNAL_ERROR - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
INVALID_FRAME_PAYLOAD_DATA - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
io.micronaut.websocket - package io.micronaut.websocket: Classes and interfaces for supporting WebSocket.
io.micronaut.websocket.annotation - package io.micronaut.websocket.annotation: WebSocket specific annotations.
io.micronaut.websocket.bind - package io.micronaut.websocket.bind: Package containing binding related classes.
io.micronaut.websocket.context - package io.micronaut.websocket.context: Classes related to handling of WebSocket beans.
io.micronaut.websocket.event - package io.micronaut.websocket.event: WebSocket server event types.
io.micronaut.websocket.exceptions - package io.micronaut.websocket.exceptions: WebSocket related exceptions.
io.micronaut.websocket.interceptor - package io.micronaut.websocket.interceptor: Implementation classes for ClientWebSocket advice.
isOpen() - Method in interface io.micronaut.websocket.WebSocketSession: Whether the session is open.
isSecure() - Method in interface io.micronaut.websocket.WebSocketSession: Whether the connection is secure.
isWritable() - Method in interface io.micronaut.websocket.WebSocketSession: Whether the session is writable.

M

MESSAGE_TO_BIG - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
messageMethod() - Method in interface io.micronaut.websocket.context.WebSocketBean: Returns the method annotated with OnMessage responsible for regular messages.
MISSING_EXTENSION - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.

N

NO_STATUS_RECEIVED - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
NORMAL - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.

O

OnClose - Annotation Type in io.micronaut.websocket.annotation: Annotation that can be applied to a method that will receive WebSocket close frames.
OnError - Annotation Type in io.micronaut.websocket.annotation: Annotation that can be applied to a method that will receive WebSocket errors.
OnMessage - Annotation Type in io.micronaut.websocket.annotation: Annotation that can be applied to a method that will receive WebSocket message frames.
OnOpen - Annotation Type in io.micronaut.websocket.annotation: Annotation that can be applied to a method that will receive WebSocket open frames.
openMethod() - Method in interface io.micronaut.websocket.context.WebSocketBean: Returns the method annotated with OnOpen.

P

POLICY_VIOLATION - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
pongMethod() - Method in interface io.micronaut.websocket.context.WebSocketBean: Returns the method annotated with OnMessage responsible for pong messages.
PROTOCOL_ERROR - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.

R

resolveWebSocketClient(InjectionPoint<?>, LoadBalancer, HttpClientConfiguration, BeanContext) - Method in interface io.micronaut.websocket.WebSocketClientRegistry: Resolves a WebSocketClient for the given injection point.

S

SCHEME_WS - Static variable in interface io.micronaut.websocket.WebSocketClient: Constant for HTTP scheme.
SCHEME_WSS - Static variable in interface io.micronaut.websocket.WebSocketClient: Constant for HTTPS scheme.
send(T, MediaType) - Method in interface io.micronaut.websocket.WebSocketSession: Send the given message to the remote peer.
send(T) - Method in interface io.micronaut.websocket.WebSocketSession: Send the given message to the remote peer.
sendAsync(T, MediaType) - Method in interface io.micronaut.websocket.WebSocketSession: Send the given message to the remote peer asynchronously.
sendAsync(T) - Method in interface io.micronaut.websocket.WebSocketSession: Send the given message to the remote peer asynchronously.
sendPingAsync(byte[]) - Method in interface io.micronaut.websocket.WebSocketSession: Send a ping through this WebSocket.
sendSync(Object, MediaType) - Method in interface io.micronaut.websocket.WebSocketSession: Send the given message to the remote peer synchronously.
sendSync(Object) - Method in interface io.micronaut.websocket.WebSocketSession: Send the given message to the remote peer synchronously.
ServerWebSocket - Annotation Type in io.micronaut.websocket.annotation: Annotation declared on the server to indicate the class handles web socket frames.
SERVICE_RESTART - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
setWebSocketSession(WebSocketSession) - Method in interface io.micronaut.websocket.interceptor.WebSocketSessionAware: Sets the WebSocketSession.

T

TLS_HANDSHAKE - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.
toString() - Method in class io.micronaut.websocket.CloseReason
TRY_AGAIN_LATER - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.

U

UNSUPPORTED_DATA - Static variable in class io.micronaut.websocket.CloseReason: See https://tools.ietf.org/html/rfc6455#section-11.7.

V

valueOf(String) - Static method in enum io.micronaut.websocket.WebSocketVersion: Returns the enum constant of this type with the specified name.
values() - Static method in enum io.micronaut.websocket.WebSocketVersion: Returns an array containing the constants of this enum type, in the order they are declared.

W

WebSocketBean<T> - Interface in io.micronaut.websocket.context: Wrapper around a WebSocket instance that enables the retrieval of the appropriate methods.
WebSocketBeanRegistry - Interface in io.micronaut.websocket.context: Registry for WebSocket beans.
WebSocketBroadcaster - Interface in io.micronaut.websocket: Defines WebSocket methods to broadcast messages.
WebSocketClient - Interface in io.micronaut.websocket: Interface that provides a way to connect a client over WebSocket.
WebSocketClientException - Exception in io.micronaut.websocket.exceptions: Exceptions specific to the WebSocket client.
WebSocketClientException(String) - Constructor for exception io.micronaut.websocket.exceptions.WebSocketClientException
WebSocketClientException(String, Throwable) - Constructor for exception io.micronaut.websocket.exceptions.WebSocketClientException
WebSocketClientFactory - Interface in io.micronaut.websocket: A factory to create WebSocket clients.
WebSocketClientRegistry<W extends WebSocketClient> - Interface in io.micronaut.websocket: Interface for managing the construction and lifecycle of instances of reactive WebSocketClient clients.
WebSocketComponent - Annotation Type in io.micronaut.websocket.annotation: Stereotype meta-annotation declared on both ServerWebSocket and ClientWebSocket.
WebSocketEvent - Class in io.micronaut.websocket.event: Parent class for all events emitted by the WebSocket server.
WebSocketEvent(WebSocketSession) - Constructor for class io.micronaut.websocket.event.WebSocketEvent: Default constructor.
WebSocketException - Exception in io.micronaut.websocket.exceptions: General parent exception for all WebSocket related exceptions.
WebSocketException(String) - Constructor for exception io.micronaut.websocket.exceptions.WebSocketException
WebSocketException(String, Throwable) - Constructor for exception io.micronaut.websocket.exceptions.WebSocketException
WebSocketMapping - Annotation Type in io.micronaut.websocket.annotation: Stereotype meta-annotation applied to all WebSocket related annotations such as OnOpen, OnMessage etc..
WebSocketMessageProcessedEvent<T> - Class in io.micronaut.websocket.event: An event fired after a WebSocket message has been processed.
WebSocketMessageProcessedEvent(WebSocketSession, T) - Constructor for class io.micronaut.websocket.event.WebSocketMessageProcessedEvent: Default constructor.
WebSocketPongMessage - Class in io.micronaut.websocket: Special message class that can be accepted by a @OnMessage method to listen to WebSocket pongs.
WebSocketPongMessage(ByteBuffer<?>) - Constructor for class io.micronaut.websocket.WebSocketPongMessage
WebSocketSession - Interface in io.micronaut.websocket: Represents an open WebSocket connection.
WebSocketSessionAware - Interface in io.micronaut.websocket.interceptor: Interface used by ClientWebSocket to gain access to the underlying WebSocketSession.
WebSocketSessionClosedEvent - Class in io.micronaut.websocket.event: Fired when a WebSocketSession is closed on the server.
WebSocketSessionClosedEvent(WebSocketSession) - Constructor for class io.micronaut.websocket.event.WebSocketSessionClosedEvent: Default constructor.
WebSocketSessionException - Exception in io.micronaut.websocket.exceptions: Exceptions related to WebSocketSession interaction.
WebSocketSessionException(String) - Constructor for exception io.micronaut.websocket.exceptions.WebSocketSessionException
WebSocketSessionException(String, Throwable) - Constructor for exception io.micronaut.websocket.exceptions.WebSocketSessionException
WebSocketSessionOpenEvent - Class in io.micronaut.websocket.event: Fired when a WebSocketSession is opened on the Server.
WebSocketSessionOpenEvent(WebSocketSession) - Constructor for class io.micronaut.websocket.event.WebSocketSessionOpenEvent: Default constructor.
WebSocketState - Class in io.micronaut.websocket.bind: Holder object used to bind WebSocket state.
WebSocketState(WebSocketSession, HttpRequest<?>) - Constructor for class io.micronaut.websocket.bind.WebSocketState: Default constructor.
WebSocketStateBinder<T> - Interface in io.micronaut.websocket.bind: Interface for binders that bind from WebSocketState.
WebSocketStateBinderRegistry - Class in io.micronaut.websocket.bind: Handles binding WebSocket arguments from WebSocketState.
WebSocketStateBinderRegistry(RequestBinderRegistry) - Constructor for class io.micronaut.websocket.bind.WebSocketStateBinderRegistry: Default constructor.
WebSocketVersion - Enum in io.micronaut.websocket: Enum representing the different WebSocket versions.

A B C D E F G H I M N O P R S T U V W