类 WebSocketTransport
- java.lang.Object
- org.springframework.web.socket.sockjs.client.WebSocketTransport
public class WebSocketTransport extends Object implements Transport, Lifecycle
A SockJSTransport
that uses aWebSocketClient
.- 从以下版本开始:
- 4.1
- 作者:
- Rossen Stoyanchev
构造器概要
构造器 构造器 说明 WebSocketTransport(WebSocketClient webSocketClient)
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 ListenableFuture<WebSocketSession>
connect(TransportRequest request, WebSocketHandler handler)
Connect the transport.List<TransportType>
getTransportTypes()
Return the SockJS transport types that this transport can be used for.WebSocketClient
getWebSocketClient()
Return the configuredWebSocketClient
.boolean
isRunning()
Check whether this component is currently running.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.String
toString()
构造器详细资料
WebSocketTransport
public WebSocketTransport(WebSocketClient webSocketClient)
方法详细资料
getWebSocketClient
public WebSocketClient getWebSocketClient()
Return the configuredWebSocketClient
.
getTransportTypes
public List<TransportType> getTransportTypes()
从接口复制的说明:Transport
Return the SockJS transport types that this transport can be used for. In particular since from a client perspective there is no difference between XHR and XHR streaming, anXhrTransport
could do both.- 指定者:
getTransportTypes
在接口中Transport
connect
public ListenableFuture<WebSocketSession> connect(TransportRequest request, WebSocketHandler handler)
从接口复制的说明:Transport
Connect the transport.
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.