public static interface ServerResponse.SseBuilder| 修飾子と型 | メソッドと説明 |
|---|---|
ServerResponse.SseBuilder | comment(StringSE comment)SSE コメントを追加します。 |
void | complete() イベントストリームを完了します。 |
void | data(ObjectSE object) 指定されたオブジェクトの SSE「データ」行を追加し、構築されたサーバー送信イベントをクライアントに送信します。 |
void | error(ThrowableSE t) 指定されたエラーでイベントストリームを完了します。 |
ServerResponse.SseBuilder | event(StringSE eventName)SSE「イベント」行を追加します。 |
ServerResponse.SseBuilder | id(StringSE id)SSE "id" 行を追加します。 |
ServerResponse.SseBuilder | onComplete(RunnableSE onCompletion)SSE リクエストが完了したときに呼び出されるコールバックを登録します。 |
ServerResponse.SseBuilder | onError(ConsumerSE<ThrowableSE> onError)SSE 処理中にエラーが発生したときに呼び出されるコールバックを登録します。 |
ServerResponse.SseBuilder | onTimeout(RunnableSE onTimeout)SSE リクエストがタイムアウトしたときに呼び出されるコールバックを登録します。 |
ServerResponse.SseBuilder | retry(DurationSE duration)SSE「再試行」行を追加します。 |
void | send(ObjectSE object) 指定されたオブジェクトをサーバー送信イベントとして送信します。 |
void send(ObjectSE object) throws IOExceptionSE
この便利なメソッドは、data(Object) と同じ効果があります。
object - 送信するオブジェクト IOExceptionSE - I/O エラーの場合 ServerResponse.SseBuilder id(StringSE id)
id - イベント識別子 ServerResponse.SseBuilder event(StringSE eventName)
eventName - イベント名 ServerResponse.SseBuilder retry(DurationSE duration)
duration - ミリに変換する期間 ServerResponse.SseBuilder comment(StringSE comment)
comment - コメント void data(ObjectSE object) throws IOExceptionSE
object - データとして送信するオブジェクト IOExceptionSE - I/O エラーの場合 void error(ThrowableSE t)
スローアブルは Spring MVC にディスパッチされ、例外処理メカニズムに渡されます。この時点でレスポンスがコミットされているため、レスポンスステータスを変更することはできません。
t - ディスパッチするスローアブル void complete()
ServerResponse.SseBuilder onTimeout(RunnableSE onTimeout)
onTimeout - タイムアウト時に呼び出すコールバック ServerResponse.SseBuilder onError(ConsumerSE<ThrowableSE> onError)
onError - エラー時に呼び出すコールバック ServerResponse.SseBuilder onComplete(RunnableSE onCompletion)
onCompletion - 完了時に呼び出されるコールバック