Class WebSocketTransport
java.lang.Object
org.springframework.web.socket.sockjs.client.WebSocketTransport
- All Implemented Interfaces:
org.springframework.context.Lifecycle
,Transport
public class WebSocketTransport
extends Object
implements Transport, org.springframework.context.Lifecycle
A SockJS
Transport
that uses a
WebSocketClient
.- Since:
- 4.1
- Author:
- Rossen Stoyanchev
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionconnectAsync
(TransportRequest request, WebSocketHandler handler) Connect the transport.Get the SockJS transport types that this transport can be used for.Return the configuredWebSocketClient
.boolean
void
start()
void
stop()
toString()
-
Constructor Details
-
WebSocketTransport
-
-
Method Details
-
getWebSocketClient
Return the configuredWebSocketClient
. -
getTransportTypes
Description copied from interface:Transport
Get 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, an
XhrTransport
could do both.- Specified by:
getTransportTypes
in interfaceTransport
-
connectAsync
public CompletableFuture<WebSocketSession> connectAsync(TransportRequest request, WebSocketHandler handler) Description copied from interface:Transport
Connect the transport.- Specified by:
connectAsync
in interfaceTransport
- Parameters:
request
- the transport requesthandler
- the application handler to delegate lifecycle events to- Returns:
- a future to indicate success or failure to connect
-
start
public void start()- Specified by:
start
in interfaceorg.springframework.context.Lifecycle
-
stop
public void stop()- Specified by:
stop
in interfaceorg.springframework.context.Lifecycle
-
isRunning
public boolean isRunning()- Specified by:
isRunning
in interfaceorg.springframework.context.Lifecycle
-
toString
-