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

インターフェース HandshakeHandler

すべての既知の実装クラス:
AbstractHandshakeHandler、DefaultHandshakeHandler、WebSocketTransportHandler
public interface HandshakeHandler
WebSocket ハンドシェイクリクエストを処理するための契約。
導入:
4.0
作成者:
Rossen Stoyanchev
関連事項:

  • メソッドの詳細

    • doHandshake

      boolean doHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler, MapSE<StringSE,ObjectSE> attributes) throws HandshakeFailureException
      ハンドシェイクを開始します。
      パラメーター:
      request - 現在のリクエスト
      response - 現在のレスポンス
      wsHandler - WebSocket メッセージを処理するハンドラー。ハンドラーに接続ごとのライフサイクルを提供する方法については、PerConnectionWebSocketHandler を参照してください。
      attributes - WebSocket セッションに関連付ける HTTP ハンドシェイクの属性。提供された属性がコピーされ、元のマップは使用されません。
      戻り値:
      握手交渉が成功したかどうか。どちらの場合も、レスポンスステータス、ヘッダー、本文は、交渉の結果を反映するように更新されます
      例外:
      HandshakeFailureException - 内部の回復不可能なエラー（つまり、ハンドシェイクのネゴシエーションに失敗したのではなくサーバーエラー）が原因でハンドシェイク処理が完了しなかった場合にスローされます。