パッケージ org.springframework.web.socket.config

クラス WebSocketMessageBrokerStats

java.lang.ObjectSE
org.springframework.web.socket.config.WebSocketMessageBrokerStats
実装されたすべてのインターフェース:
SmartInitializingSingleton
public class WebSocketMessageBrokerStats extends ObjectSE implements SmartInitializingSingleton
Java 構成の @EnableWebSocketMessageBroker と XML の <websocket:message-broker> に付属するセットアップの主要インフラストラクチャコンポーネントから内部状態とカウンタに関する情報を集約するための主要クラス。

デフォルトでは、集約された情報は INFO レベルで 30 分ごとにログに記録されます。ロギングの頻度は setLoggingPeriod(long) を介して変更できます。

このクラスは、上記の構成により "webSocketMessageBrokerStats" という名前で Spring Bean として宣言され、たとえば MBeanExporter を使用して JMX に簡単にエクスポートできます。

導入:
4.1
作成者:
Rossen Stoyanchev, Sam Brannen, Brian Clozel

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

    • WebSocketMessageBrokerStats

      public WebSocketMessageBrokerStats()

  • メソッドの詳細

    • setSubProtocolWebSocketHandler

      public void setSubProtocolWebSocketHandler(SubProtocolWebSocketHandler webSocketHandler)

    • setStompBrokerRelay

      public void setStompBrokerRelay(StompBrokerRelayMessageHandler stompBrokerRelay)

    • setInboundChannelExecutor

      public void setInboundChannelExecutor(TaskExecutor inboundChannelExecutor)

    • setOutboundChannelExecutor

      public void setOutboundChannelExecutor(TaskExecutor outboundChannelExecutor)

    • setSockJsTaskScheduler

      public void setSockJsTaskScheduler(TaskScheduler sockJsTaskScheduler)

    • setLoggingPeriod

      public void setLoggingPeriod(long period)
      情報をロギングする頻度を INFO レベルでミリ秒単位で設定します。0 または 0 未満に設定すると、ロギングタスクはキャンセルされます。

      デフォルトでは、このプロパティは 30 分（30 * 60 * 1000）に設定されています。

    • getLoggingPeriod

      public long getLoggingPeriod()
      設定されたロギング期間の頻度をミリ秒単位で返します。

    • afterSingletonsInstantiated

      public void afterSingletonsInstantiated()
      インターフェースからコピーされた説明: SmartInitializingSingleton
      シングルトン事前インスタンス化フェーズの終わりに呼び出され、すべての通常のシングルトン Bean がすでに作成されていることを保証します。このメソッド内の ListableBeanFactory.getBeansOfType(java.lang.Class<T>) 呼び出しは、ブートストラップ中に偶発的な副作用を引き起こしません。

      注意 : このコールバックは、BeanFactory ブートストラップ後にオンデマンドで遅延初期化されたシングルトン Bean ではトリガーされず、他の Bean スコープでもトリガーされません。意図されたブートストラップセマンティクスのみを使用する Bean には慎重に使用してください。

      次で指定:
      インターフェース SmartInitializingSingleton の afterSingletonsInstantiated 

    • getWebSocketSessionStatsInfo

      @DeprecatedSE(since="6.2", forRemoval=true) public StringSE getWebSocketSessionStatsInfo()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      6.2 現在、getWebSocketSessionStats() を推奨
      WebSocket セッションに関する統計を取得します。

    • getWebSocketSessionStats

      @Nullable public SubProtocolWebSocketHandler.Stats getWebSocketSessionStats()
      WebSocket セッションに関する統計を取得します。WebSocket handler が構成されていない場合は、null を返すことができます。
      導入:
      6.2

    • getStompSubProtocolStatsInfo

      @DeprecatedSE(since="6.2", forRemoval=true) public StringSE getStompSubProtocolStatsInfo()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      6.2 現在、getStompSubProtocolStats() を推奨
      STOMP 関連の WebSocket メッセージ処理に関する統計を取得します。

    • getStompSubProtocolStats

      @Nullable public StompSubProtocolHandler.Stats getStompSubProtocolStats()
      STOMP 関連の WebSocket メッセージ処理に関する統計を取得します。SubProtocolHandler が見つからない場合は、null を返すことができます。
      導入:
      6.2

    • getStompBrokerRelayStatsInfo

      @DeprecatedSE(since="6.2", forRemoval=true) public StringSE getStompBrokerRelayStatsInfo()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      6.2 現在、getStompBrokerRelayStats() を推奨
      STOMP ブローカーリレーに関する統計を取得します（フル機能の STOMP ブローカーを使用している場合）。

    • getStompBrokerRelayStats

      @Nullable public StompBrokerRelayMessageHandler.Stats getStompBrokerRelayStats()
      STOMP ブローカーリレーに関する統計を取得します (フル機能の STOMP ブローカーを使用している場合)。STOMP broker relay が構成されていない場合は、null を返すことができます。
      導入:
      6.2

    • getClientInboundExecutorStatsInfo

      public StringSE getClientInboundExecutorStatsInfo()
      WebSocket クライアントからの受信メッセージを処理するエグゼキューターに関する統計を取得します。

    • getClientOutboundExecutorStatsInfo

      public StringSE getClientOutboundExecutorStatsInfo()
      WebSocket クライアントへの発信メッセージを処理する executor に関する統計を取得します。

    • getSockJsTaskSchedulerStatsInfo

      public StringSE getSockJsTaskSchedulerStatsInfo()
      SockJS タスクスケジューラに関する統計を取得します。

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString