Package org.springframework.web.reactive.socket.server.upgrade

Class JettyRequestUpgradeStrategy

java.lang.Object

org.springframework.web.reactive.socket.server.upgrade.JettyRequestUpgradeStrategy

All Implemented Interfaces:

RequestUpgradeStrategy

public class JettyRequestUpgradeStrategy
extends Object
implements RequestUpgradeStrategy

A WebSocket RequestUpgradeStrategy for Jetty 11.

Since:

5.3.4

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Constructor	Description
JettyRequestUpgradeStrategy()

Method Summary

Modifier and Type	Method	Description
void	addWebSocketConfigurer(Consumer<org.eclipse.jetty.websocket.api.Configurable> webSocketConfigurer)	Add a callback to configure WebSocket server parameters on JettyWebSocketServerContainer.
reactor.core.publisher.Mono<Void>	upgrade(ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory)	Upgrade to a WebSocket session and handle it with the given handler.

Methods inherited from class java.lang.Object

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

Constructor Details

JettyRequestUpgradeStrategy

public JettyRequestUpgradeStrategy()

Method Details

addWebSocketConfigurer

public void addWebSocketConfigurer(Consumer<org.eclipse.jetty.websocket.api.Configurable> webSocketConfigurer)

Add a callback to configure WebSocket server parameters on JettyWebSocketServerContainer.

Since:

6.1

upgrade

public reactor.core.publisher.Mono<Void> upgrade(ServerWebExchange exchange,
 WebSocketHandler handler,
 @Nullable
 String subProtocol,
 Supplier<HandshakeInfo> handshakeInfoFactory)

Description copied from interface: RequestUpgradeStrategy

Upgrade to a WebSocket session and handle it with the given handler.

Specified by:

upgrade in interface RequestUpgradeStrategy

Parameters:

exchange - the current exchange

handler - handler for the WebSocket session

subProtocol - the selected sub-protocol got the handler

handshakeInfoFactory - factory to create HandshakeInfo for the WebSocket session

Returns:

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