クラス StandardWebSocketClient
java.lang.ObjectSE
org.springframework.web.reactive.socket.client.StandardWebSocketClient
- 実装されているすべてのインターフェース:
WebSocketClient
- 既知の直属サブクラス
TomcatWebSocketClient
Jakarta WebSocket API で使用する
WebSocketClient 実装。- 導入:
- 5.0
- 作成者:
- Violeta Georgieva, Rossen Stoyanchev
- 関連事項:
コンストラクターの概要
コンストラクターコンストラクター説明ContainerProvider.getWebSocketContainer()を呼び出して(新しい)WebSocketContainerインスタンスを取得するデフォルトのコンストラクター。StandardWebSocketClient(jakarta.websocket.WebSocketContainer webSocketContainer) 既存のWebSocketContainerインスタンスを受け入れるコンストラクター。メソッドのサマリー
修飾子と型メソッド説明protected DataBufferFactory使用するDataBufferFactoryを返します。protected jakarta.websocket.ClientEndpointConfigcreateEndpointConfig(jakarta.websocket.ClientEndpointConfig.Configurator configurator, ListSE<StringSE> subProtocols) 指定されたコンフィギュレータのClientEndpointConfigを作成します。protected StandardWebSocketSessioncreateWebSocketSession(jakarta.websocket.Session session, HandshakeInfo info, reactor.core.publisher.Sinks.Empty<VoidSE> completionSink) 指定された Jakarta WebSocket Session のStandardWebSocketSessionを作成します。reactor.core.publisher.Mono<VoidSE> execute(URISE url, HttpHeaders headers, WebSocketHandler handler) カスタムヘッダーを持つWebSocketClient.execute(URI, WebSocketHandler)のバリアント。reactor.core.publisher.Mono<VoidSE> execute(URISE url, WebSocketHandler handler) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。jakarta.websocket.WebSocketContainer使用する構成済みのWebSocketContainerを返します。
コンストラクターの詳細
StandardWebSocketClient
public StandardWebSocketClient()ContainerProvider.getWebSocketContainer()を呼び出して(新しい)WebSocketContainerインスタンスを取得するデフォルトのコンストラクター。StandardWebSocketClient
public StandardWebSocketClient(jakarta.websocket.WebSocketContainer webSocketContainer) 既存のWebSocketContainerインスタンスを受け入れるコンストラクター。- パラメーター:
webSocketContainer- Web ソケットコンテナー
メソッドの詳細
getWebSocketContainer
public jakarta.websocket.WebSocketContainer getWebSocketContainer()使用する構成済みのWebSocketContainerを返します。execute
インターフェースからコピーされた説明:WebSocketClient指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- 次で指定:
- インターフェース
WebSocketClientのexecute - パラメーター:
url- ハンドシェイク URLhandler- WebSocket セッションのハンドラー- 戻り値:
- WebSocket セッション処理の結果を示す
Mono<Void>の完了。
execute
public reactor.core.publisher.Mono<VoidSE> execute(URISE url, HttpHeaders headers, WebSocketHandler handler) インターフェースからコピーされた説明:WebSocketClientカスタムヘッダーを持つWebSocketClient.execute(URI, WebSocketHandler)のバリアント。- 次で指定:
- インターフェース
WebSocketClientのexecute - パラメーター:
url- ハンドシェイク URLheaders- ハンドシェイクリクエストのカスタムヘッダーhandler- WebSocket セッションのハンドラー- 戻り値:
- WebSocket セッション処理の結果を示す
Mono<Void>の完了。
createWebSocketSession
protected StandardWebSocketSession createWebSocketSession(jakarta.websocket.Session session, HandshakeInfo info, reactor.core.publisher.Sinks.Empty<VoidSE> completionSink) 指定された Jakarta WebSocket Session のStandardWebSocketSessionを作成します。- 関連事項:
bufferFactory
createEndpointConfig
protected jakarta.websocket.ClientEndpointConfig createEndpointConfig(jakarta.websocket.ClientEndpointConfig.Configurator configurator, ListSE<StringSE> subProtocols) 指定されたコンフィギュレータのClientEndpointConfigを作成します。拡張機能や SSL コンテキストを追加するにはオーバーライドします。- パラメーター:
configurator- 適用するコンフィギュレータsubProtocols- 優先サブプロトコル- 導入:
- 6.1.3