インターフェース WebSocketClient
- すべての既知の実装クラス:
AbstractWebSocketClient
、SockJsClient
、StandardWebSocketClient
public interface WebSocketClient
WebSocket リクエストを開始するための契約。代替として、アプリケーションの起動時に事前構成された URI への WebSocket 接続を開始する宣言型スタイル
WebSocketConnectionManager
の使用を検討します。- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
- 関連事項:
メソッドのサマリー
修飾子と型メソッド説明default ListenableFuture<WebSocketSession>
doHandshake
(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVariables) 使用すべきではありません。default ListenableFuture<WebSocketSession>
doHandshake
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URISE uri) 使用すべきではありません。execute
(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVariables) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。execute
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URISE uri) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。
メソッドの詳細
doHandshake
@DeprecatedSE(since="6.0") default ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVariables) 使用すべきではありません。6.0 現在、execute(WebSocketHandler, String, Object...)
を推奨指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- パラメーター:
webSocketHandler
- セッションハンドラーuriTemplate
- URL テンプレートuriVariables
- テンプレートを展開する変数- 戻り値:
- セッションが利用可能になったときに完了するフューチャ
execute
CompletableFutureSE<WebSocketSession> execute(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVariables) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- パラメーター:
webSocketHandler
- セッションハンドラーuriTemplate
- URL テンプレートuriVariables
- テンプレートを展開する変数- 戻り値:
- セッションが利用可能になったときに完了するフューチャ
- 導入:
- 6.0
doHandshake
@DeprecatedSE(since="6.0") default ListenableFuture<WebSocketSession> doHandshake(WebSocketHandler webSocketHandler, @Nullable WebSocketHttpHeaders headers, URISE uri) 使用すべきではありません。指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- パラメーター:
webSocketHandler
- セッションハンドラーuri
- URL- 戻り値:
- セッションが利用可能になったときに完了するフューチャ
execute
CompletableFutureSE<WebSocketSession> execute(WebSocketHandler webSocketHandler, @Nullable WebSocketHttpHeaders headers, URISE uri) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- パラメーター:
webSocketHandler
- セッションハンドラーuri
- URL- 戻り値:
- セッションが利用可能になったときに完了するフューチャ
- 導入:
- 6.0
execute(WebSocketHandler, String, Object...)
を推奨