org.springframework.web.reactive.socket

Interface WebSocketHandler

public interface WebSocketHandler

Handler for a WebSocket session.

Since:

5.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
default List<String>	getSubProtocols() Return the list of sub-protocols supported by this handler.
reactor.core.publisher.Mono<Void>	handle(WebSocketSession session) Handle the WebSocket session.

Method Detail

getSubProtocols

default List<String> getSubProtocols()

Return the list of sub-protocols supported by this handler.

By default an empty list is returned.

handle

reactor.core.publisher.Mono<Void> handle(WebSocketSession session)

Handle the WebSocket session.

Parameters:

session - the session to handle

Returns:

completion Mono<Void> to indicate the outcome of the WebSocket session handling.