Top Description Interfaces Classes

module spring.websocket

Package org.springframework.web.socket.messaging

Annotations

@NonNullApi
@NonNullFields

Imports

org.springframework.lang.NonNullApi, .NonNullFields

WebSocket integration for Spring's messaging module.

Interface Summary

Modifier and Type	Interface and Description
public interface	SubProtocolErrorHandler< the message payload type P> A contract for handling sub-protocol errors sent to clients.
public interface	SubProtocolHandler A contract for handling WebSocket messages as part of a higher level protocol, referred to as "sub-protocol" in the WebSocket RFC specification.

Class Summary

Modifier and Type	Class and Description
public abstract class	AbstractSubProtocolEvent A base class for events for a message received from a WebSocket client and parsed into a higher-level sub-protocol (e.g. STOMP).
public class	DefaultSimpUserRegistry A default implementation of `SimpUserRegistry` that relies on `AbstractSubProtocolEvent` application context events to keep track of connected users and their subscriptions.
public class	SessionConnectedEvent A connected event represents the server response to a client's connect request.
public class	SessionConnectEvent Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g. STOMP) as the WebSocket sub-protocol issues a connect request.
public class	SessionDisconnectEvent Event raised when the session of a WebSocket client using a Simple Messaging Protocol (e.g. STOMP) as the WebSocket sub-protocol is closed.
public class	SessionSubscribeEvent Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g. STOMP) sends a subscription request.
public class	SessionUnsubscribeEvent Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g. STOMP) sends a request to remove a subscription.
public class	StompSubProtocolErrorHandler A `SubProtocolErrorHandler` for use with STOMP.
public class	StompSubProtocolHandler A `SubProtocolHandler` for STOMP that supports versions 1.0, 1.1, and 1.2 of the STOMP specification.
public class	SubProtocolWebSocketHandler An implementation of `WebSocketHandler` that delegates incoming WebSocket messages to a `SubProtocolHandler` along with a `MessageChannel` to which the sub-protocol handler can send messages from WebSocket clients to the application.
public class	WebSocketAnnotationMethodMessageHandler A subclass of `SimpAnnotationMethodMessageHandler` to provide support for `ControllerAdvice` with global `@MessageExceptionHandler` methods.
public class	WebSocketStompClient A STOMP over WebSocket client that connects using an implementation of `WebSocketClient` including `SockJsClient`.