Package org.springframework.web.socket.client

Interface WebSocketClient

All Known Implementing Classes:

AbstractWebSocketClient, JettyWebSocketClient, 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
ListenableFuture<WebSocketSession>	doHandshake(WebSocketHandler webSocketHandler, String uriTemplate, Object... uriVariables)
ListenableFuture<WebSocketSession>	doHandshake(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URI uri)

Method Details

doHandshake

ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
 String uriTemplate,
 Object... uriVariables)

doHandshake

ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler,
 @Nullable
 WebSocketHttpHeaders headers,
 URI uri)