パッケージ org.springframework.integration.websocket

クラス 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

  • コンストラクターの詳細

    • ClientWebSocketContainer

      public ClientWebSocketContainer(WebSocketClient client, StringSE uriTemplate, ObjectSE... uriVariables)

    • ClientWebSocketContainer

      public ClientWebSocketContainer(WebSocketClient client, URISE uri)
      準備された URISE を持つコンストラクター。
      パラメーター:
      client - 使用する WebSocketClient。
      uri - 接続する URL
      導入:
      6.1

  • 方法の詳細

    • setOrigin

      public void setOrigin(StringSE origin)

    • setHeadersMap

      public void setHeadersMap(MapSE<StringSE,StringSE> headers)

    • setHeaders

      public void setHeaders(HttpHeaders headers)

    • setConnectionTimeout

      public void setConnectionTimeout(int connectionTimeout)
      接続タイムアウトを秒単位で設定します。デフォルト: 10。
      パラメーター:
      connectionTimeout - 秒単位のタイムアウト。
      導入:
      4.2

    • getSession

      public WebSocketSession getSession(@Nullable StringSE sessionId)
      clientSession WebSocketSession を返します。提供された引数とは関係なく、このメソッドは常に確立された clientSession のみを返します
      オーバーライド:
      クラス 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

      public boolean isRunning()
      次で指定:
      インターフェース Lifecycle 内の isRunning 

    • start

      public void start()
      次で指定:
      インターフェース Lifecycle 内の start 

    • stop

      public void stop()
      次で指定:
      インターフェース Lifecycle 内の stop 

    • stop

      public void stop(RunnableSE callback)
      次で指定:
      インターフェース SmartLifecycle 内の stop