Package org.springframework.web.socket.messaging
WebSocket integration for Spring's messaging module.
Interface Summary Interface Description SubProtocolErrorHandler<P> A contract for handling sub-protocol errors sent to clients.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 Class Description AbstractSubProtocolEvent A base class for events for a message received from a WebSocket client and parsed into a higher-level sub-protocol (e.g.DefaultSimpUserRegistry A default implementation ofSimpUserRegistry
that relies onAbstractSubProtocolEvent
application context events to keep track of connected users and their subscriptions.SessionConnectedEvent A connected event represents the server response to a client's connect request.SessionConnectEvent Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g.SessionDisconnectEvent Event raised when the session of a WebSocket client using a Simple Messaging Protocol (e.g.SessionSubscribeEvent Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g.SessionUnsubscribeEvent Event raised when a new WebSocket client using a Simple Messaging Protocol (e.g.StompSubProtocolErrorHandler ASubProtocolErrorHandler
for use with STOMP.StompSubProtocolHandler ASubProtocolHandler
for STOMP that supports versions 1.0, 1.1, and 1.2 of the STOMP specification.SubProtocolWebSocketHandler An implementation ofWebSocketHandler
that delegates incoming WebSocket messages to aSubProtocolHandler
along with aMessageChannel
to which the sub-protocol handler can send messages from WebSocket clients to the application.WebSocketAnnotationMethodMessageHandler A sub-class ofSimpAnnotationMethodMessageHandler
to provide support forControllerAdvice
with global@MessageExceptionHandler
methods.WebSocketStompClient A STOMP over WebSocket client that connects using an implementation ofWebSocketClient
includingSockJsClient
.