インターフェース ServerResponse.StreamBuilder
- 含まれているインターフェース:
- ServerResponse
public static interface ServerResponse.StreamBuilder
ストリーミングレスポンス本文のビルダーを定義します。
- 導入:
- 6.2
メソッドのサマリー
修飾子と型メソッド説明void
complete()
ストリームを完了します。void
error
(ThrowableSE t) 指定されたエラーでストリームを完了します。void
flush()
バッファリングされたレスポンスストリームの内容をネットワークにフラッシュします。onComplete
(RunnableSE onCompletion) リクエストが完了したときに呼び出されるコールバックを登録します。onError
(ConsumerSE<ThrowableSE> onError) 処理中にエラーが発生したときに呼び出されるコールバックを登録します。onTimeout
(RunnableSE onTimeout) リクエストがタイムアウトしたときに呼び出されるコールバックを登録します。指定されたオブジェクトをフラッシュせずにレスポンスストリームに書き込みます。指定されたオブジェクトをフラッシュせずにレスポンスストリームに書き込みます。
メソッドの詳細
error
指定されたエラーでストリームを完了します。スローアブルは Spring MVC にディスパッチされ、例外処理メカニズムに渡されます。この時点でレスポンスがコミットされているため、レスポンスステータスを変更することはできません。
- パラメーター:
t
- ディスパッチするスローアブル
complete
void complete()ストリームを完了します。onTimeout
リクエストがタイムアウトしたときに呼び出されるコールバックを登録します。- パラメーター:
onTimeout
- タイムアウト時に呼び出すコールバック- 戻り値:
- このビルダー
onError
処理中にエラーが発生したときに呼び出されるコールバックを登録します。- パラメーター:
onError
- エラー時に呼び出すコールバック- 戻り値:
- このビルダー
onComplete
リクエストが完了したときに呼び出されるコールバックを登録します。- パラメーター:
onCompletion
- 完了時に呼び出されるコールバック- 戻り値:
- このビルダー
write
指定されたオブジェクトをフラッシュせずにレスポンスストリームに書き込みます。文字列は UTF-8 でエンコードされたバイトとして送信され、バイト配列はそのまま送信され、その他のオブジェクトはメッセージコンバーターを使用して JSON に変換されます。- パラメーター:
object
- データとして送信するオブジェクト- 戻り値:
- このビルダー
- 例外:
IOExceptionSE
- I/O エラーの場合
write
ServerResponse.StreamBuilder write(ObjectSE object, @Nullable MediaType mediaType) throws IOExceptionSE 指定されたオブジェクトをフラッシュせずにレスポンスストリームに書き込みます。文字列は UTF-8 でエンコードされたバイトとして送信され、バイト配列はそのまま送信され、その他のオブジェクトはメッセージコンバーターを使用して JSON に変換されます。- パラメーター:
object
- データとして送信するオブジェクトmediaType
- 提供されたデータをエンコードするために使用するメディア型- 戻り値:
- このビルダー
- 例外:
IOExceptionSE
- I/O エラーの場合
flush
バッファリングされたレスポンスストリームの内容をネットワークにフラッシュします。- 例外:
IOExceptionSE
- I/O エラーの場合