クラス ClientWebSocketContainer
java.lang.ObjectSE
org.springframework.integration.websocket.IntegrationWebSocketContainer
org.springframework.integration.websocket.ClientWebSocketContainer
- 実装されたすべてのインターフェース:
DisposableBean
、Lifecycle
、Phased
、SmartLifecycle
public final class ClientWebSocketContainer
extends IntegrationWebSocketContainer
implements SmartLifecycle
client
Web-Socket 接続用の IntegrationWebSocketContainer
実装。 内部 ConnectionManagerSupport
実装の構成を表します。
getSession(String)
を使用してこのコンテナーからアクセスできる ConnectionManagerSupport.openConnection()
イベントで clientSession
WebSocketSession
を受け入れます。
- 導入:
- 4.1
- 作成者:
- Artem Bilan, Gary Russell, Christian Tzolov
フィールドのサマリー
クラス org.springframework.integration.websocket.IntegrationWebSocketContainer から継承されたフィールド
DEFAULT_SEND_BUFFER_SIZE, DEFAULT_SEND_TIME_LIMIT, lock, logger, sessions
インターフェース org.springframework.context.SmartLifecycle から継承されたフィールド
DEFAULT_PHASE
コンストラクターの概要
コンストラクターコンストラクター説明ClientWebSocketContainer
(WebSocketClient client, StringSE uriTemplate, ObjectSE... uriVariables) ClientWebSocketContainer
(WebSocketClient client, URISE uri) 準備されたURI
SE を持つコンストラクター。メソッドのサマリー
修飾子と型メソッド説明int
getPhase()
getSession
(StringSE sessionId) clientSession
WebSocketSession
を返します。boolean
boolean
clientSession
が開いている場合は、true
を返します。boolean
void
setAutoStartup
(boolean autoStartup) void
setConnectionTimeout
(int connectionTimeout) 接続タイムアウトを秒単位で設定します。デフォルト: 10。void
setHeaders
(HttpHeaders headers) void
setHeadersMap
(MapSE<StringSE, StringSE> headers) void
void
setPhase
(int phase) void
start()
void
stop()
void
stop
(RunnableSE callback) クラス org.springframework.integration.websocket.IntegrationWebSocketContainer から継承されたメソッド
addSupportedProtocols, closeSession, destroy, getSessions, getSubProtocols, getWebSocketHandler, setMessageListener, setSendBufferOverflowStrategy, setSendBufferSizeLimit, setSendTimeLimit, setSupportedProtocols, setWebSocketHandler
コンストラクターの詳細
ClientWebSocketContainer
public ClientWebSocketContainer(WebSocketClient client, StringSE uriTemplate, ObjectSE... uriVariables) ClientWebSocketContainer
準備されたURI
SE を持つコンストラクター。- パラメーター:
client
- 使用するWebSocketClient
。uri
- 接続する URL- 導入:
- 6.1
メソッドの詳細
setOrigin
setHeadersMap
setHeaders
setConnectionTimeout
public void setConnectionTimeout(int connectionTimeout) 接続タイムアウトを秒単位で設定します。デフォルト: 10。- パラメーター:
connectionTimeout
- 秒単位のタイムアウト。- 導入:
- 4.2
getSession
- オーバーライド:
- クラス
IntegrationWebSocketContainer
のgetSession
- パラメーター:
sessionId
-sessionId
。null
にすることができます。- 戻り値:
clientSession
(確立されている場合)。
setAutoStartup
public void setAutoStartup(boolean autoStartup) setPhase
public void setPhase(int phase) isConnected
public boolean isConnected()clientSession
が開いている場合は、true
を返します。- 戻り値:
WebSocketSession.isOpen()
状態。- 導入:
- 4.2.6
isAutoStartup
public boolean isAutoStartup()- 次で指定:
- インターフェース
SmartLifecycle
のisAutoStartup
getPhase
public int getPhase()- 次で指定:
- インターフェース
Phased
のgetPhase
- 次で指定:
- インターフェース
SmartLifecycle
のgetPhase
isRunning
start
stop
stop
- 次で指定:
- インターフェース
SmartLifecycle
のstop