クラス SseEmitter
java.lang.ObjectSE
org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitter
org.springframework.web.servlet.mvc.method.annotation.SseEmitter
サーバー送信イベントを送信するための
ResponseBodyEmitter
の特殊化。- 導入:
- 4.2
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller, Sam Brannen
ネストされたクラスのサマリー
ネストされたクラスクラス org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitter から継承されたネストクラス / インターフェース
ResponseBodyEmitter.DataWithMediaType
コンストラクターのサマリー
コンストラクターコンストラクター説明新しい SseEmitter インスタンスを作成します。SseEmitter
(LongSE timeout) カスタムタイムアウト値を使用して SseEmitter を作成します。メソッドのサマリー
修飾子と型メソッド説明static SseEmitter.SseEventBuilder
event()
protected void
extendResponse
(ServerHttpResponse outputMessage) ResponseBodyEmitter が ResponseEntity でラップされている場合、ステータスコードとヘッダーでレスポンスが更新された後で、レスポンスがコミットされる前に呼び出されます。void
単一の SSE「データ」行としてフォーマットされたオブジェクトを送信します。void
単一の SSE「データ」行としてフォーマットされたオブジェクトを送信します。void
send
(SseEmitter.SseEventBuilder builder) 指定されたビルダーで準備された SSE イベントを送信します。toString()
クラス org.springframework.web.servlet.mvc.method.annotation.ResponseBodyEmitter から継承されたメソッド
complete, completeWithError, getTimeout, onCompletion, onError, onTimeout
コンストラクターの詳細
SseEmitter
public SseEmitter()新しい SseEmitter インスタンスを作成します。SseEmitter
カスタムタイムアウト値を使用して SseEmitter を作成します。デフォルトでは設定されていません。この場合、MVC Java Config または MVC 名前空間で設定されたデフォルトが使用されます。または、設定されていない場合、タイムアウトは基盤となるサーバーのデフォルトによって異なります。
- パラメーター:
timeout
- ミリ秒単位のタイムアウト値- 導入:
- 4.2.2
メソッドの詳細
extendResponse
クラスからコピーされた説明:ResponseBodyEmitter
ResponseBodyEmitter が ResponseEntity でラップされている場合、ステータスコードとヘッダーでレスポンスが更新された後で、レスポンスがコミットされる前、つまりレスポンスの本文が書き込まれる前に呼び出されます。デフォルトの実装は空です。
- オーバーライド:
- クラス
ResponseBodyEmitter
のextendResponse
send
単一の SSE「データ」行としてフォーマットされたオブジェクトを送信します。これは次と同等です。// static import of SseEmitter.* SseEmitter emitter = new SseEmitter(); emitter.send(event().data(myObject));
例外処理に関する重要な注意事項については、
parent Javadoc
を参照してください。- オーバーライド:
- クラス
ResponseBodyEmitter
のsend
- パラメーター:
object
- 書き込むオブジェクト- 例外:
IOExceptionSE
- I/O エラーが発生したときに発生しますIllegalStateExceptionSE
- 他のエラーをラップします
send
単一の SSE「データ」行としてフォーマットされたオブジェクトを送信します。これは次と同等です。// static import of SseEmitter.* SseEmitter emitter = new SseEmitter(); emitter.send(event().data(myObject, MediaType.APPLICATION_JSON));
例外処理に関する重要な注意事項については、
parent Javadoc
を参照してください。- オーバーライド:
- クラス
ResponseBodyEmitter
のsend
- パラメーター:
object
- 書き込むオブジェクトmediaType
- HttpMessageConverter を選択するための MediaType ヒント- 例外:
IOExceptionSE
- I/O エラーが発生したときに発生します
send
指定されたビルダーで準備された SSE イベントを送信します。例:// static import of SseEmitter SseEmitter emitter = new SseEmitter(); emitter.send(event().name("update").id("1").data(myObject));
- パラメーター:
builder
- SSE 形式のイベントのビルダー。- 例外:
IOExceptionSE
- I/O エラーが発生したときに発生します
toString
- オーバーライド:
- クラス
ResponseBodyEmitter
のtoString
event