Top Description Methods
org.springframework.web.socket.sockjs.client

public Interface Transport

Known Direct Subinterfaces
org.springframework.web.socket.sockjs.client.XhrTransport
Known Direct Implementers
org.springframework.web.socket.sockjs.client.WebSocketTransport
Imports
java.util.List, java.util.concurrent.CompletableFuture, org.springframework.web.socket.WebSocketHandler, .WebSocketSession, org.springframework.web.socket.sockjs.transport.TransportType
A client-side implementation for a SockJS transport.
Author
Rossen Stoyanchev
Since
4.1

Method Summary

Modifier and TypeMethod and Description
public default ListenableFuture<WebSocketSession>

Returns:

a future to indicate success or failure to connect
connect(TransportRequest
the transport request
request, WebSocketHandler
the application handler to delegate lifecycle events to
webSocketHandler)
Deprecated since 6.0. as of 6.0, in favor of connectAsync(TransportRequest, WebSocketHandler)

Connect the transport.

public CompletableFuture<WebSocketSession>

Returns:

a future to indicate success or failure to connect
connectAsync(TransportRequest
the transport request
request, WebSocketHandler
the application handler to delegate lifecycle events to
webSocketHandler)

Connect the transport.

public List<TransportType>
getTransportTypes()

Get the SockJS transport types that this transport can be used for.

Method Detail

connectback to summary
public default ListenableFuture<WebSocketSession> connect(TransportRequest request, WebSocketHandler webSocketHandler)

Deprecated

since 6.0.

as of 6.0, in favor of connectAsync(TransportRequest, WebSocketHandler)

Connect the transport.

Parameters
request:TransportRequest

the transport request

webSocketHandler:WebSocketHandler

the application handler to delegate lifecycle events to

Returns:ListenableFuture<WebSocketSession>

a future to indicate success or failure to connect

Annotations
@Deprecated
since:6.0
connectAsyncback to summary
public CompletableFuture<WebSocketSession> connectAsync(TransportRequest request, WebSocketHandler webSocketHandler)

Connect the transport.

Parameters
request:TransportRequest

the transport request

webSocketHandler:WebSocketHandler

the application handler to delegate lifecycle events to

Returns:CompletableFuture<WebSocketSession>

a future to indicate success or failure to connect

Since
6.0
getTransportTypesback to summary
public List<TransportType> getTransportTypes()

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.