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