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

インターフェース SubProtocolHandler

すべての既知の実装クラス:
StompSubProtocolHandler
public interface SubProtocolHandler
WebSocket RFC 仕様で「サブプロトコル」と呼ばれる、上位レベルのプロトコルの一部として WebSocket メッセージを処理するための規約。クライアントからの WebSocketMessages とクライアントへの Messages の両方を処理します。

このインターフェースの実装は、Sec-WebSocket-Protocol リクエストヘッダーを介してクライアントからリクエストされたサブプロトコルに基づいてメッセージを委譲するサブプロトコルハンドラーを選択する SubProtocolWebSocketHandler で構成できます。

導入:
4.0
作成者:
Andy Wilkinson, Rossen Stoyanchev

  • メソッドの詳細

    • getSupportedProtocols

      ListSE<StringSE> getSupportedProtocols()
      このハンドラーでサポートされているサブプロトコルのリストを返します（非 null）。

    • handleMessageFromClient

      void handleMessageFromClient(WebSocketSession session, WebSocketMessage<?> message, MessageChannel outputChannel) throws ExceptionSE
      クライアントから受信した特定の WebSocketMessage を処理します。
      パラメーター:
      session - クライアントセッション
      message - クライアントメッセージ
      outputChannel - メッセージを送信する出力チャネル
      例外:
      ExceptionSE

    • handleMessageToClient

      void handleMessageToClient(WebSocketSession session, Message<?> message) throws ExceptionSE
      指定された WebSocket セッションに関連付けられたクライアントに対して、指定された Message を処理します。
      パラメーター:
      session - クライアントセッション
      message - クライアントメッセージ
      例外:
      ExceptionSE

    • resolveSessionId

      @Nullable StringSE resolveSessionId(Message<?> message)
      指定されたメッセージからセッション ID を解決するか、null を返します。
      パラメーター:
      message - セッション ID を解決するメッセージ

    • afterSessionStarted

      void afterSessionStarted(WebSocketSession session, MessageChannel outputChannel) throws ExceptionSE
      WebSocketSession が開始した後に呼び出されます。
      パラメーター:
      session - クライアントセッション
      outputChannel - チャンネル
      例外:
      ExceptionSE

    • afterSessionEnded

      void afterSessionEnded(WebSocketSession session, CloseStatus closeStatus, MessageChannel outputChannel) throws ExceptionSE
      WebSocketSession が終了した後に呼び出されます。
      パラメーター:
      session - クライアントセッション
      closeStatus - セッションが閉じられた理由
      outputChannel - チャンネル
      例外:
      ExceptionSE