パッケージ org.springframework.messaging.simp.stomp

インターフェース StompSessionHandler

すべてのスーパーインターフェース:
StompFrameHandler
すべての既知の実装クラス:
StompSessionHandlerAdapter
public interface StompSessionHandler extends StompFrameHandler
セッションが確立されたときのコールバックや、トランスポートまたはメッセージ処理の失敗の通知を含む、クライアント STOMP セッションライフサイクルイベントの契約。

この契約は、ブローカーから受信した STOMP ERROR フレームを処理するために StompFrameHandler も拡張します。

このインターフェースの実装では、StompSessionHandlerAdapter の拡張を検討する必要があります。

導入:
4.2
作成者:
Rossen Stoyanchev
関連事項:

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    afterConnected(StompSession session, StompHeaders connectedHeaders)
    セッションが使用できる状態になったときに呼び出されます。
    void
    handleException(StompSession session, StompCommand command, StompHeaders headers, byte[] payload, ThrowableSE exception)
    ペイロードの変換の失敗やアプリケーション StompFrameHandler の未処理の例外など、STOMP フレームの処理中に発生した例外を処理します。
    void
    handleTransportError(StompSession session, ThrowableSE exception)
    I/O エラーまたは STOMP メッセージのエンコードまたはデコードの失敗である可能性のある低レベルのトランスポートエラーを処理します。

    インターフェース org.springframework.messaging.simp.stomp.StompFrameHandler から継承されたメソッド

    getPayloadType, handleFrame

  • メソッドの詳細

    • afterConnected

      void afterConnected(StompSession session, StompHeaders connectedHeaders)
      セッションが使用できる状態になったとき、つまり、基になるトランスポート（TCP、WebSocket）が接続され、ブローカーから STOMP CONNECTED フレームが受信された後に呼び出されます。
      パラメーター:
      session - クライアント STOMP セッション
      connectedHeaders - STOMP CONNECTED フレームヘッダー

    • handleException

      void handleException(StompSession session, @Nullable StompCommand command, StompHeaders headers, byte[] payload, ThrowableSE exception)
      ペイロードの変換の失敗やアプリケーション StompFrameHandler の未処理の例外など、STOMP フレームの処理中に発生した例外を処理します。
      パラメーター:
      session - クライアント STOMP セッション
      command - フレームの STOMP コマンド
      headers - ヘッダー
      payload - 生のペイロード
      exception - 例外

    • handleTransportError

      void handleTransportError(StompSession session, ThrowableSE exception)
      I/O エラーまたは STOMP メッセージのエンコードまたはデコードの失敗である可能性のある低レベルのトランスポートエラーを処理します。

      StompSession.disconnect() を介して接続が正常に閉じられるのではなく、ConnectionLostException がこのメソッドに渡されることに注意してください。

      パラメーター:
      session - クライアント STOMP セッション
      exception - 発生した例外