クラス AbstractWebSocketClient
java.lang.ObjectSE
org.springframework.web.socket.client.AbstractWebSocketClient
- 実装されたすべてのインターフェース:
WebSocketClient
- 既知の直属サブクラス
JettyWebSocketClient
,StandardWebSocketClient
WebSocketClient
実装の抽象基本クラス。- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
フィールドサマリー
フィールドコンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明protected void
protected ListenableFuture<WebSocketSession>
doHandshakeInternal
(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> subProtocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 使用すべきではありません。execute
(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVars) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。execute
(WebSocketHandler webSocketHandler, WebSocketHttpHeaders headers, URISE uri) 指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。protected abstract CompletableFutureSE<WebSocketSession>
executeInternal
(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> subProtocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 実際のハンドシェイクを実行して、サーバーへの接続を確立します。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.web.socket.client.WebSocketClient から継承されたメソッド
doHandshake, doHandshake
フィールドの詳細
logger
コンストラクターの詳細
AbstractWebSocketClient
public AbstractWebSocketClient()
メソッドの詳細
execute
public CompletableFutureSE<WebSocketSession> execute(WebSocketHandler webSocketHandler, StringSE uriTemplate, ObjectSE... uriVars) インターフェースからコピーされた説明:WebSocketClient
指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- 次で指定:
- インターフェース
WebSocketClient
のexecute
- パラメーター:
webSocketHandler
- セッションハンドラーuriTemplate
- URL テンプレートuriVars
- テンプレートを展開する変数- 戻り値:
- セッションが利用可能になったときに完了するフューチャ
execute
public final CompletableFutureSE<WebSocketSession> execute(WebSocketHandler webSocketHandler, @Nullable WebSocketHttpHeaders headers, URISE uri) インターフェースからコピーされた説明:WebSocketClient
指定された URL に対してハンドシェイクリクエストを実行し、指定されたハンドラーで結果の WebSocket セッションを処理します。- 次で指定:
- インターフェース
WebSocketClient
のexecute
- パラメーター:
webSocketHandler
- セッションハンドラーuri
- URL- 戻り値:
- セッションが利用可能になったときに完了するフューチャ
assertUri
doHandshakeInternal
@DeprecatedSE(since="6.0") protected ListenableFuture<WebSocketSession> doHandshakeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> subProtocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 使用すべきではありません。実際のハンドシェイクを実行して、サーバーへの接続を確立します。- パラメーター:
webSocketHandler
- WebSocket メッセージのクライアント側ハンドラーheaders
- ハンドシェイクに使用する HTTP ヘッダー。不要な(禁止されている)ヘッダーはフィルターで除外されます (非null
)uri
- ハンドシェイクのターゲット URI (非null
)subProtocols
- リクエストされたサブプロトコル、または空のリストextensions
- リクエストされた WebSocket 拡張、または空のリストattributes
- WebSocketSession に関連付ける属性、つまりWebSocketSession.getAttributes()
を経由します。現在は常に空のマップです。- 戻り値:
ListenableFuture
でラップされた、確立された WebSocket セッション。
executeInternal
protected abstract CompletableFutureSE<WebSocketSession> executeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> subProtocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 実際のハンドシェイクを実行して、サーバーへの接続を確立します。- パラメーター:
webSocketHandler
- WebSocket メッセージのクライアント側ハンドラーheaders
- ハンドシェイクに使用する HTTP ヘッダー。不要な(禁止されている)ヘッダーはフィルターで除外されます (非null
)uri
- ハンドシェイクのターゲット URI (非null
)subProtocols
- リクエストされたサブプロトコル、または空のリストextensions
- リクエストされた WebSocket 拡張、または空のリストattributes
- WebSocketSession に関連付ける属性 (つまり、WebSocketSession.getAttributes()
経由)。現在、常に空のマップ- 戻り値:
CompletableFuture
でラップされた、確立された WebSocket セッション。
executeInternal(WebSocketHandler, HttpHeaders, URI, List, List, Map)
を推奨