Interface WebSocketListener
- All Superinterfaces:
org.springframework.web.socket.SubProtocolCapable
- All Known Implementing Classes:
WebSocketInboundChannelAdapter
public interface WebSocketListener
extends org.springframework.web.socket.SubProtocolCapable
A contract for handling incoming
WebSocketMessages messages as part of a higher
level protocol, referred to as "sub-protocol" in the WebSocket RFC specification.
Implementations of this interface can be configured on a
IntegrationWebSocketContainer which delegates messages and
WebSocketSession events to this implementation.
- Since:
- 4.1
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionvoidafterSessionEnded(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.CloseStatus closeStatus) Invoked after aWebSocketSessionhas ended.voidafterSessionStarted(org.springframework.web.socket.WebSocketSession session) Invoked after aWebSocketSessionhas started.voidonMessage(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.WebSocketMessage<?> message) Handle the receivedWebSocketMessage.Methods inherited from interface org.springframework.web.socket.SubProtocolCapable
getSubProtocols
-
Method Details
-
onMessage
void onMessage(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.WebSocketMessage<?> message) throws Exception Handle the receivedWebSocketMessage.- Parameters:
session- the WebSocket sessionmessage- the WebSocket message- Throws:
Exception- the 'onMessage' Exception
-
afterSessionStarted
Invoked after aWebSocketSessionhas started.- Parameters:
session- the WebSocket session- Throws:
Exception- the 'afterSessionStarted' Exception
-
afterSessionEnded
void afterSessionEnded(org.springframework.web.socket.WebSocketSession session, org.springframework.web.socket.CloseStatus closeStatus) throws Exception Invoked after aWebSocketSessionhas ended.- Parameters:
session- the WebSocket sessioncloseStatus- the reason why the session was closed- Throws:
Exception- the 'afterSessionEnded' Exception
-