Package org.springframework.web.socket.client

Interface WebSocketClient

All Known Implementing Classes:

AbstractWebSocketClient, SockJsClient, StandardWebSocketClient

public interface WebSocketClient

Contract for initiating a WebSocket request. As an alternative considering using the declarative style WebSocketConnectionManager that starts a WebSocket connection to a pre-configured URI when the application starts.

Since:

4.0

Author:

Rossen Stoyanchev

See Also:

• WebSocketConnectionManager

Method Summary

Modifier and Type	Method	Description
default ListenableFuture<WebSocketSession>	doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVariables)	Deprecated, for removal: This API element is subject to removal in a future version. as of 6.0, in favor of execute(WebSocketHandler, String, Object...)
default ListenableFuture<WebSocketSession>	doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)	Deprecated, for removal: This API element is subject to removal in a future version. as of 6.0, in favor of execute(WebSocketHandler, WebSocketHttpHeaders, URI)
CompletableFuture<WebSocketSession>	execute(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVariables)	Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.
CompletableFuture<WebSocketSession>	execute(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)	Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

Method Details

doHandshake

@Deprecated(since="6.0",
            forRemoval=true)
default ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
 String uriTemplate,
 Object... uriVariables)

Deprecated, for removal: This API element is subject to removal in a future version.

as of 6.0, in favor of execute(WebSocketHandler, String, Object...)

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

Parameters:

webSocketHandler - the session handler

uriTemplate - the url template

uriVariables - the variables to expand the template

Returns:

a future that completes when the session is available

execute

CompletableFuture<WebSocketSession> execute(WebSocketHandler webSocketHandler,
 String uriTemplate,
 Object... uriVariables)

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

Parameters:

webSocketHandler - the session handler

uriTemplate - the url template

uriVariables - the variables to expand the template

Returns:

a future that completes when the session is available

Since:

6.0

doHandshake

@Deprecated(since="6.0",
            forRemoval=true)
default ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
 @Nullable
 WebSocketHttpHeaders headers,
 URI uri)

Deprecated, for removal: This API element is subject to removal in a future version.

as of 6.0, in favor of execute(WebSocketHandler, WebSocketHttpHeaders, URI)

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

Parameters:

webSocketHandler - the session handler

uri - the url

Returns:

a future that completes when the session is available

execute

CompletableFuture<WebSocketSession> execute(WebSocketHandler webSocketHandler,
 @Nullable
 WebSocketHttpHeaders headers,
 URI uri)

Execute a handshake request to the given url and handle the resulting WebSocket session with the given handler.

Parameters:

webSocketHandler - the session handler

uri - the url

Returns:

a future that completes when the session is available

Since:

6.0