クラス ServerSentEventHttpMessageWriter
java.lang.ObjectSE
org.springframework.http.codec.ServerSentEventHttpMessageWriter
- 実装されているすべてのインターフェース:
HttpMessageWriter<ObjectSE>
public class ServerSentEventHttpMessageWriter
extends ObjectSE
implements HttpMessageWriter<ObjectSE>
"text/event-stream" レスポンスの場合は HttpMessageWriter。- 導入:
- 5.0
- 作成者:
- Sebastien Deleuze, Arjen Poutsma, Rossen Stoyanchev
コンストラクターの概要
コンストラクターコンストラクター説明Encoderなしのコンストラクター。ServerSentEventHttpMessageWriter(@Nullable Encoder<?> encoder) オブジェクトをエンコードするための JSONEncoderを持つコンストラクター。方法の概要
修飾子と型メソッド説明booleancanWrite(ResolvableType elementType, @Nullable MediaType mediaType) 指定されたオブジェクト型がこのライターでサポートされているかどうか。設定されたEncoderを返します（ある場合）。このライターでサポートされているメディア型のリストを返します。write(Publisher<?> input, ResolvableType actualType, ResolvableType elementType, @Nullable MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) 追加のコンテキストが利用可能な、HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)のサーバー側のみの代替。write(Publisher<?> input, ResolvableType elementType, @Nullable MediaType mediaType, ReactiveHttpOutputMessage message, MapSE<StringSE, ObjectSE> hints) オブジェクトの特定のストリームを出力メッセージに書き込みます。クラス ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース HttpMessageWriter から継承されたメソッド
getWritableMediaTypes
コンストラクターの詳細
ServerSentEventHttpMessageWriter
public ServerSentEventHttpMessageWriter()Encoderなしのコンストラクター。このモードでは、エンコードされるイベントデータに対してStringのみがサポートされます。ServerSentEventHttpMessageWriter
メソッドの詳細
getEncoder
getWritableMediaTypes
インターフェースからコピーされた説明:HttpMessageWriterこのライターでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null)を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、HttpMessageWriter.getWritableMediaTypes(ResolvableType)を使用してより正確なリストを作成します。- 次で指定:
- インターフェース
HttpMessageWriter<ObjectSE>のgetWritableMediaTypes - 戻り値:
- サポートされているメディア型の一般的なリスト
canWrite
インターフェースからコピーされた説明:HttpMessageWriter指定されたオブジェクト型がこのライターでサポートされているかどうか。- 次で指定:
- インターフェース
HttpMessageWriter<ObjectSE>のcanWrite - パラメーター:
elementType- チェックするオブジェクトの型mediaType- 書き込みのメディア型 (おそらくnull)- 戻り値:
- 書き込み可能な場合は
true、それ以外の場合はfalse
write
public Mono<VoidSE> write(Publisher<?> input, ResolvableType elementType, @Nullable MediaType mediaType, ReactiveHttpOutputMessage message, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageWriterオブジェクトの特定のストリームを出力メッセージに書き込みます。- 次で指定:
- インターフェース
HttpMessageWriter<ObjectSE>のwrite - パラメーター:
input- 書き込むオブジェクトelementType-HttpMessageWriter.canWrite(ResolvableType, MediaType)を介して事前にチェックされている必要があるストリーム内のオブジェクトの型mediaType- 書き込みのコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示すnull)message- 書き込むメッセージhints- エンコードおよび書き込み方法に関する追加情報- 戻り値:
- 完了またはエラーを示します
write
public Mono<VoidSE> write(Publisher<?> input, ResolvableType actualType, ResolvableType elementType, @Nullable MediaType mediaType, ServerHttpRequest request, ServerHttpResponse response, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageWriter追加のコンテキストが利用可能な、HttpMessageWriter.write(Publisher, ResolvableType, MediaType, ReactiveHttpOutputMessage, Map)のサーバー側のみの代替。- 次で指定:
- インターフェース
HttpMessageWriter<ObjectSE>のwrite - パラメーター:
actualType- 値を返したメソッドの実際の戻り値の型。アノテーション付きコントローラーの場合、MethodParameterはResolvableType.getSource()を介してアクセスできます。elementType- 入力ストリーム内のオブジェクトの型mediaType- 使用するコンテンツ型 (ライターのデフォルトのコンテンツ型を使用する必要があることを示すnull)request- 現在のリクエストresponse- 現在のレスポンス- 戻り値:
- 書き込みの完了またはエラーを示す
Mono