public class ReactorNettyRequestUpgradeStrategy extends Object implements RequestUpgradeStrategy
RequestUpgradeStrategy
for use with Reactor Netty.Constructor and Description |
---|
ReactorNettyRequestUpgradeStrategy() |
Modifier and Type | Method and Description |
---|---|
boolean |
getHandlePing()
Return the configured
setHandlePing(boolean) . |
int |
getMaxFramePayloadLength()
Return the configured max length for frames.
|
void |
setHandlePing(boolean handlePing)
Configure whether to let ping frames through to be handled by the
WebSocketHandler given to the upgrade method. |
void |
setMaxFramePayloadLength(Integer maxFramePayloadLength)
Configure the maximum allowable frame payload length.
|
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
upgrade
public void setMaxFramePayloadLength(Integer maxFramePayloadLength)
Corresponds to the argument with the same name in the constructor of
WebSocketServerHandshakerFactory
in Netty.
By default set to 65536 (64K).
maxFramePayloadLength
- the max length for frames.public int getMaxFramePayloadLength()
public void setHandlePing(boolean handlePing)
WebSocketHandler
given to the upgrade method. By default, Reactor
Netty automatically replies with pong frames in response to pings. This is
useful in a proxy for allowing ping and pong frames through.
By default this is set to false
in which case ping frames are
handled automatically by Reactor Netty. If set to true
, ping
frames will be passed through to the WebSocketHandler
.
handlePing
- whether to let Ping frames through for handlingpublic boolean getHandlePing()
setHandlePing(boolean)
.public reactor.core.publisher.Mono<Void> upgrade(ServerWebExchange exchange, WebSocketHandler handler, @Nullable String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory)
RequestUpgradeStrategy
upgrade
in interface RequestUpgradeStrategy
exchange
- the current exchangehandler
- handler for the WebSocket sessionsubProtocol
- the selected sub-protocol got the handlerhandshakeInfoFactory
- factory to create HandshakeInfo for the WebSocket sessionMono<Void>
to indicate the outcome of the
WebSocket session handling.