クラス 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
EE インスタンスを取得するデフォルトのコンストラクター。StandardWebSocketClient
(WebSocketContainerEE webSocketContainer) 既存のWebSocketContainer
EE インスタンスを受け入れるコンストラクター。メソッドのサマリー
修飾子と型メソッド説明protected DataBufferFactory
使用するDataBufferFactory
を返します。protected ClientEndpointConfigEE
createEndpointConfig
(ClientEndpointConfig.ConfiguratorEE configurator, ListSE<StringSE> subProtocols) 指定されたコンフィギュレーターのClientEndpointConfig
EE を作成します。protected StandardWebSocketSession
createWebSocketSession
(SessionEE 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 セッションを処理します。使用する構成済みWebSocketContainer
EE を返します。
コンストラクターの詳細
StandardWebSocketClient
public StandardWebSocketClient()ContainerProvider.getWebSocketContainer()
を呼び出して(新しい)WebSocketContainer
EE インスタンスを取得するデフォルトのコンストラクター。StandardWebSocketClient
既存のWebSocketContainer
EE インスタンスを受け入れるコンストラクター。- パラメーター:
webSocketContainer
- Web ソケットコンテナー
メソッドの詳細
getWebSocketContainer
使用する構成済みWebSocketContainer
EE を返します。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(SessionEE session, HandshakeInfo info, reactor.core.publisher.Sinks.Empty<VoidSE> completionSink) 指定された Jakarta WebSocket Session のStandardWebSocketSession
を作成します。- 関連事項:
bufferFactory
使用するDataBufferFactory
を返します。createEndpointConfig
protected ClientEndpointConfigEE createEndpointConfig(ClientEndpointConfig.ConfiguratorEE configurator, ListSE<StringSE> subProtocols) 指定されたコンフィギュレーターのClientEndpointConfig
EE を作成します。オーバーライドして拡張機能または SSL コンテキストを追加できます。- パラメーター:
configurator
- 適用するコンフィギュレータsubProtocols
- 優先サブプロトコル- 導入:
- 6.1.3