クラス ServerSentEventHttpMessageReader
java.lang.ObjectSE
org.springframework.http.codec.ServerSentEventHttpMessageReader
- 実装されたすべてのインターフェース:
HttpMessageReader<ObjectSE>
public class ServerSentEventHttpMessageReader
extends ObjectSE
implements HttpMessageReader<ObjectSE>
- 導入:
- 5.0
- 作成者:
- Sebastien Deleuze, Rossen Stoyanchev, Juergen Hoeller
コンストラクターのサマリー
コンストラクターコンストラクター説明Decoder
なしのコンストラクター。ServerSentEventHttpMessageReader
(Decoder<?> decoder) オブジェクトにデコードするための JSONDecoder
を持つコンストラクター。方法の概要
修飾子と型メソッド説明boolean
canRead
(ResolvableType elementType, MediaType mediaType) 指定されたオブジェクト型がこのリーダーでサポートされているかどうか。Decoder<?>
設定されたDecoder
を返します。int
configured
バイトカウント制限を返します。このリーダーでサポートされているメディア型のリストを返します。reactor.core.publisher.Flux<ObjectSE>
read
(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints) 入力メッセージから読み取り、オブジェクトのストリームにデコードします。reactor.core.publisher.Mono<ObjectSE>
readMono
(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints) 入力メッセージから読み取り、単一のオブジェクトにデコードします。void
setMaxInMemorySize
(int byteCount) イベントが解析される前にバッファリングされる SSE イベントごとの最大バイト数の制限を構成します。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.http.codec.HttpMessageReader から継承されたメソッド
getReadableMediaTypes, read, readMono
コンストラクターの詳細
ServerSentEventHttpMessageReader
public ServerSentEventHttpMessageReader()Decoder
なしのコンストラクター。このモードでは、イベントのデータとしてString
のみがサポートされています。ServerSentEventHttpMessageReader
オブジェクトにデコードするための JSONDecoder
を持つコンストラクター。String
イベントデータへのデコードのサポートが組み込まれています。
メソッドの詳細
getDecoder
設定されたDecoder
を返します。setMaxInMemorySize
public void setMaxInMemorySize(int byteCount) イベントが解析される前にバッファリングされる SSE イベントごとの最大バイト数の制限を構成します。data decoder
が提供されている場合は、イベントのデータ部分を解析できるようにするために、必要に応じて制限を上げるようにカスタマイズする必要があることに注意してください。デフォルトでは、これは 256K に設定されています。
- パラメーター:
byteCount
- バッファリングする最大バイト数、または無制限の場合は -1- 導入:
- 5.1.13
getMaxInMemorySize
public int getMaxInMemorySize()configured
バイトカウント制限を返します。- 導入:
- 5.1.13
getReadableMediaTypes
インターフェースからコピーされた説明:HttpMessageReader
このリーダーでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null)
を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、HttpMessageReader.getReadableMediaTypes(ResolvableType)
を使用してより正確なリストを作成します。- 次で指定:
- インターフェース
HttpMessageReader<ObjectSE>
のgetReadableMediaTypes
- 戻り値:
- サポートされているメディア型の一般的なリスト
canRead
インターフェースからコピーされた説明:HttpMessageReader
指定されたオブジェクト型がこのリーダーでサポートされているかどうか。- 次で指定:
- インターフェース
HttpMessageReader<ObjectSE>
のcanRead
- パラメーター:
elementType
- チェックするオブジェクトの型mediaType
- 読み取り用のメディア型 (おそらくnull
)- 戻り値:
- 読み取り可能な場合は
true
、そうでない場合はfalse
read
public reactor.core.publisher.Flux<ObjectSE> read(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageReader
入力メッセージから読み取り、オブジェクトのストリームにデコードします。- 次で指定:
- インターフェース
HttpMessageReader<ObjectSE>
のread
- パラメーター:
elementType
-HttpMessageReader.canRead(ResolvableType, MediaType)
を介して事前にチェックされている必要があるストリーム内のオブジェクトの型message
- 読み取るメッセージhints
- 入力の読み取りおよびデコード方法に関する追加情報- 戻り値:
- 要素のデコードされたストリーム
readMono
public reactor.core.publisher.Mono<ObjectSE> readMono(ResolvableType elementType, ReactiveHttpInputMessage message, MapSE<StringSE, ObjectSE> hints) インターフェースからコピーされた説明:HttpMessageReader
入力メッセージから読み取り、単一のオブジェクトにデコードします。- 次で指定:
- インターフェース
HttpMessageReader<ObjectSE>
のreadMono
- パラメーター:
elementType
-HttpMessageReader.canRead(ResolvableType, MediaType)
を介して事前にチェックされている必要があるストリーム内のオブジェクトの型message
- 読み取るメッセージhints
- 入力の読み取りおよびデコード方法に関する追加情報- 戻り値:
- デコードされたオブジェクト