パッケージ org.springframework.web.servlet.function

インターフェース ServerResponse.SseBuilder

含まれているインターフェース:
ServerResponse
public static interface ServerResponse.SseBuilder
サーバー送信イベントを送信するボディのビルダーを定義します。
導入:
5.3.2

  • メソッドの詳細

    • send

      void send(ObjectSE object) throws IOExceptionSE
      指定されたオブジェクトをサーバー送信イベントとして送信します。文字列は UTF-8 でエンコードされたバイトとして送信され、他のオブジェクトはメッセージコンバーターを使用して JSON に変換されます。

      この便利なメソッドは、data(Object) と同じ効果があります。

      パラメーター:
      object - 送信するオブジェクト
      例外:
      IOExceptionSE - I/O エラーの場合

    • send

      void send() throws IOExceptionSE
      バッファリングされたコンテンツをデータなしでサーバー送信イベントとして送信します。events と comments のみの発送となります。
      例外:
      IOExceptionSE - I/O エラーの場合
      導入:
      6.1.4

    • id

      ServerResponse.SseBuilder id(StringSE id)
      SSE "id" 行を追加します。
      パラメーター:
      id - イベント識別子
      戻り値:
      このビルダー

    • event

      ServerResponse.SseBuilder event(StringSE eventName)
      SSE「イベント」行を追加します。
      パラメーター:
      eventName - イベント名
      戻り値:
      このビルダー

    • retry

      ServerResponse.SseBuilder retry(DurationSE duration)
      SSE「再試行」行を追加します。
      パラメーター:
      duration - ミリに変換する期間
      戻り値:
      このビルダー

    • comment

      ServerResponse.SseBuilder comment(StringSE comment)
      SSE コメントを追加します。
      パラメーター:
      comment - コメント
      戻り値:
      このビルダー

    • data

      void data(ObjectSE object) throws IOExceptionSE
      指定されたオブジェクトの SSE「データ」行を追加し、構築されたサーバー送信イベントをクライアントに送信します。文字列は UTF-8 でエンコードされたバイトとして送信され、他のオブジェクトはメッセージコンバーターを使用して JSON に変換されます。
      パラメーター:
      object - データとして送信するオブジェクト
      例外:
      IOExceptionSE - I/O エラーの場合

    • error

      void error(ThrowableSE t)
      指定されたエラーでイベントストリームを完了します。

      スローアブルは Spring MVC にディスパッチされ、例外処理メカニズムに渡されます。この時点でレスポンスがコミットされているため、レスポンスステータスを変更することはできません。

      パラメーター:
      t - ディスパッチするスローアブル

    • complete

      void complete()
      イベントストリームを完了します。

    • onTimeout

      ServerResponse.SseBuilder onTimeout(RunnableSE onTimeout)
      SSE リクエストがタイムアウトしたときに呼び出されるコールバックを登録します。
      パラメーター:
      onTimeout - タイムアウト時に呼び出すコールバック
      戻り値:
      このビルダー

    • onError

      ServerResponse.SseBuilder onError(ConsumerSE<ThrowableSE> onError)
      SSE 処理中にエラーが発生したときに呼び出されるコールバックを登録します。
      パラメーター:
      onError - エラー時に呼び出すコールバック
      戻り値:
      このビルダー

    • onComplete

      ServerResponse.SseBuilder onComplete(RunnableSE onCompletion)
      SSE リクエストが完了したときに呼び出されるコールバックを登録します。
      パラメーター:
      onCompletion - 完了時に呼び出されるコールバック
      戻り値:
      このビルダー