org.springframework.web.reactive.socket.server.support

Class HandshakeWebSocketService

java.lang.Object

org.springframework.web.reactive.socket.server.support.HandshakeWebSocketService

All Implemented Interfaces:

org.springframework.context.Lifecycle, WebSocketService

public class HandshakeWebSocketService
extends java.lang.Object
implements WebSocketService, org.springframework.context.Lifecycle

WebSocketService implementation that handles a WebSocket HTTP handshake request by delegating to a RequestUpgradeStrategy which is either auto-detected (no-arg constructor) from the classpath but can also be explicitly configured.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
protected static Log	logger

Constructor Summary

Constructors

Constructor and Description
HandshakeWebSocketService() Default constructor automatic, classpath detection based discovery of the RequestUpgradeStrategy to use.
HandshakeWebSocketService(RequestUpgradeStrategy upgradeStrategy) Alternative constructor with the RequestUpgradeStrategy to use.

Method Summary

Modifier and Type	Method and Description
protected void	doStart()
protected void	doStop()
RequestUpgradeStrategy	getUpgradeStrategy() Return the RequestUpgradeStrategy for WebSocket requests.
reactor.core.publisher.Mono<java.lang.Void>	handleRequest(org.springframework.web.server.ServerWebExchange exchange, WebSocketHandler handler) Handle the HTTP request and use the given WebSocketHandler.
boolean	isRunning()
void	start()
void	stop()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final Log logger

Constructor Detail

HandshakeWebSocketService

public HandshakeWebSocketService()

Default constructor automatic, classpath detection based discovery of the RequestUpgradeStrategy to use.

HandshakeWebSocketService

public HandshakeWebSocketService(RequestUpgradeStrategy upgradeStrategy)

Alternative constructor with the RequestUpgradeStrategy to use.

Parameters:

upgradeStrategy - the strategy to use

Method Detail

getUpgradeStrategy

public RequestUpgradeStrategy getUpgradeStrategy()

Return the RequestUpgradeStrategy for WebSocket requests.

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

doStart

protected void doStart()

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

doStop

protected void doStop()

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

handleRequest

public reactor.core.publisher.Mono<java.lang.Void> handleRequest(org.springframework.web.server.ServerWebExchange exchange,
                                                                 WebSocketHandler handler)

Description copied from interface: WebSocketService

Handle the HTTP request and use the given WebSocketHandler.

Specified by:

handleRequest in interface WebSocketService

Parameters:

exchange - the current exchange

handler - handler for WebSocket session

Returns:

a completion Mono for the WebSocket session handling