クラス StandardWebSocketClient
java.lang.ObjectSE
org.springframework.web.socket.client.AbstractWebSocketClient
org.springframework.web.socket.client.standard.StandardWebSocketClient
- 実装されたすべてのインターフェース:
WebSocketClient
標準 Java WebSocket API に基づく WebSocketClient。
- 導入:
- 4.0
- 作成者:
- Rossen Stoyanchev
フィールドサマリー
クラス org.springframework.web.socket.client.AbstractWebSocketClient から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクター説明ContainerProvider.getWebSocketContainer()
を呼び出して(新しい)WebSocketContainer
EE インスタンスを取得するデフォルトのコンストラクター。StandardWebSocketClient
(WebSocketContainerEE webSocketContainer) 既存のWebSocketContainer
EE インスタンスを受け入れるコンストラクター。メソッドのサマリー
修飾子と型メソッド説明protected CompletableFutureSE<WebSocketSession>
executeInternal
(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> protocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) 実際のハンドシェイクを実行して、サーバーへの接続を確立します。設定されたAsyncTaskExecutor
を返します。設定されたユーザープロパティ。void
setTaskExecutor
(AsyncTaskExecutor taskExecutor) 接続を開くときに使用するAsyncTaskExecutor
を設定します。void
setUserProperties
(MapSE<StringSE, ObjectSE> userProperties) 標準の Java WebSocket API では、userProperties
を介して「ユーザープロパティ」をサーバーに渡すことができます。クラス org.springframework.web.socket.client.AbstractWebSocketClient から継承されたメソッド
assertUri, doHandshakeInternal, execute, execute
クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.web.socket.client.WebSocketClient から継承されたメソッド
doHandshake, doHandshake
コンストラクターの詳細
StandardWebSocketClient
public StandardWebSocketClient()ContainerProvider.getWebSocketContainer()
を呼び出して(新しい)WebSocketContainer
EE インスタンスを取得するデフォルトのコンストラクター。既存のWebSocketContainer
インスタンスを受け入れるコンストラクターも参照してください。StandardWebSocketClient
既存のWebSocketContainer
EE インスタンスを受け入れるコンストラクター。XML 構成については、
WebSocketContainerFactoryBean
を参照してください。Java 構成の場合、ContainerProvider.getWebSocketContainer()
を使用してWebSocketContainer
インスタンスを取得します。
メソッドの詳細
setUserProperties
標準の Java WebSocket API では、userProperties
を介して「ユーザープロパティ」をサーバーに渡すことができます。このプロパティを使用して、1 つ以上のプロパティをハンドシェイクごとに渡すように構成します。getUserProperties
設定されたユーザープロパティ。setTaskExecutor
接続を開くときに使用するAsyncTaskExecutor
を設定します。このプロパティが
null
に設定されている場合、doHandshake
メソッドの呼び出しは、接続が確立されるまでブロックされます。デフォルトでは、
SimpleAsyncTaskExecutor
のインスタンスが使用されます。getTaskExecutor
設定されたAsyncTaskExecutor
を返します。executeInternal
protected CompletableFutureSE<WebSocketSession> executeInternal(WebSocketHandler webSocketHandler, HttpHeaders headers, URISE uri, ListSE<StringSE> protocols, ListSE<WebSocketExtension> extensions, MapSE<StringSE, ObjectSE> attributes) クラスからコピーされた説明:AbstractWebSocketClient
実際のハンドシェイクを実行して、サーバーへの接続を確立します。- 次で指定:
- クラス
AbstractWebSocketClient
のexecuteInternal
- パラメーター:
webSocketHandler
- WebSocket メッセージのクライアント側ハンドラーheaders
- ハンドシェイクに使用する HTTP ヘッダー。不要な(禁止されている)ヘッダーはフィルターで除外されます (非null
)uri
- ハンドシェイクのターゲット URI (非null
)protocols
- リクエストされたサブプロトコル、または空のリストextensions
- リクエストされた WebSocket 拡張、または空のリストattributes
- WebSocketSession に関連付ける属性 (つまり、WebSocketSession.getAttributes()
経由)。現在、常に空のマップ- 戻り値:
CompletableFuture
でラップされた、確立された WebSocket セッション。