类 JettyRequestUpgradeStrategy
- java.lang.Object
- org.springframework.web.reactive.socket.server.upgrade.JettyRequestUpgradeStrategy
- 所有已实现的接口:
Lifecycle
,RequestUpgradeStrategy
public class JettyRequestUpgradeStrategy extends Object implements RequestUpgradeStrategy, Lifecycle
ARequestUpgradeStrategy
for use with Jetty.- 从以下版本开始:
- 5.0
- 作者:
- Violeta Georgieva, Rossen Stoyanchev
构造器概要
构造器 构造器 说明 JettyRequestUpgradeStrategy()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 org.eclipse.jetty.websocket.api.WebSocketPolicy
getWebSocketPolicy()
Return the configuredWebSocketPolicy
, if any.boolean
isRunning()
Check whether this component is currently running.void
setWebSocketPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy webSocketPolicy)
Configure aWebSocketPolicy
to use to initializeWebSocketServerFactory
.void
start()
Start this component.void
stop()
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method.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.从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
从接口继承的方法 org.springframework.web.reactive.socket.server.RequestUpgradeStrategy
upgrade
构造器详细资料
JettyRequestUpgradeStrategy
public JettyRequestUpgradeStrategy()
方法详细资料
setWebSocketPolicy
public void setWebSocketPolicy(org.eclipse.jetty.websocket.api.WebSocketPolicy webSocketPolicy)
Configure aWebSocketPolicy
to use to initializeWebSocketServerFactory
.- 参数:
webSocketPolicy
- the WebSocket settings
getWebSocketPolicy
@Nullable public org.eclipse.jetty.websocket.api.WebSocketPolicy getWebSocketPolicy()
Return the configuredWebSocketPolicy
, if any.
start
public void start()
从接口复制的说明:Lifecycle
Start this component.Should not throw an exception if the component is already running.
In the case of a container, this will propagate the start signal to all components that apply.
- 指定者:
start
在接口中Lifecycle
- 另请参阅:
SmartLifecycle.isAutoStartup()
stop
public void stop()
从接口复制的说明:Lifecycle
Stop this component, typically in a synchronous fashion, such that the component is fully stopped upon return of this method. Consider implementingSmartLifecycle
and itsstop(Runnable)
variant when asynchronous stop behavior is necessary.Note that this stop notification is not guaranteed to come before destruction: On regular shutdown,
Lifecycle
beans will first receive a stop notification before the general destruction callbacks are being propagated; however, on hot refresh during a context's lifetime or on aborted refresh attempts, a given bean's destroy method will be called without any consideration of stop signals upfront.Should not throw an exception if the component is not running (not started yet).
In the case of a container, this will propagate the stop signal to all components that apply.
- 指定者:
stop
在接口中Lifecycle
- 另请参阅:
SmartLifecycle.stop(Runnable)
,DisposableBean.destroy()
isRunning
public boolean isRunning()
从接口复制的说明:Lifecycle
Check whether this component is currently running.In the case of a container, this will return
true
only if all components that apply are currently running.
upgrade
public reactor.core.publisher.Mono<Void> upgrade(ServerWebExchange exchange, WebSocketHandler handler, @Nullable String subProtocol, Supplier<HandshakeInfo> handshakeInfoFactory)
从接口复制的说明:RequestUpgradeStrategy
Upgrade to a WebSocket session and handle it with the given handler.- 指定者:
upgrade
在接口中RequestUpgradeStrategy
- 参数:
exchange
- the current exchangehandler
- handler for the WebSocket sessionsubProtocol
- the selected sub-protocol got the handlerhandshakeInfoFactory
- factory to create HandshakeInfo for the WebSocket session- 返回:
- completion
Mono<Void>
to indicate the outcome of the WebSocket session handling.