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

Class UndertowRequestUpgradeStrategy

java.lang.Object

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

All Implemented Interfaces:

RequestUpgradeStrategy

@Deprecated(since="6.2.18",
            forRemoval=true)
public class UndertowRequestUpgradeStrategy
extends Object
implements RequestUpgradeStrategy

Deprecated, for removal: This API element is subject to removal in a future version.

as of 6.2.18 with no replacement

A WebSocket RequestUpgradeStrategy for Undertow.

Since:

5.0

Author:

Violeta Georgieva, Rossen Stoyanchev, Brian Clozel

Constructor Summary

Constructors

Constructor	Description
UndertowRequestUpgradeStrategy()	Deprecated, for removal: This API element is subject to removal in a future version.

Method Summary

Modifier and Type	Method	Description
reactor.core.publisher.Mono<Void>	upgrade(org.springframework.web.server.ServerWebExchange exchange, WebSocketHandler handler, String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory)	Deprecated, for removal: This API element is subject to removal in a future version. 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

UndertowRequestUpgradeStrategy

public UndertowRequestUpgradeStrategy()

Deprecated, for removal: This API element is subject to removal in a future version.

Method Details

upgrade

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

Deprecated, for removal: This API element is subject to removal in a future version.

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.