パッケージ org.springframework.http.codec

クラス ServerSentEventHttpMessageReader

java.lang.ObjectSE
org.springframework.http.codec.ServerSentEventHttpMessageReader
実装されたすべてのインターフェース:
HttpMessageReader<ObjectSE>
public class ServerSentEventHttpMessageReader extends ObjectSE implements HttpMessageReader<ObjectSE>
ServerSentEvents のストリームと、データのみの ServerSentEvent と同じプレーンな ObjectsSE をサポートするリーダー。
導入:
5.0
作成者:
Sebastien Deleuze, Rossen Stoyanchev, Juergen Hoeller

  • コンストラクターの詳細

    • ServerSentEventHttpMessageReader

      public ServerSentEventHttpMessageReader()
      Decoder なしのコンストラクター。このモードでは、イベントのデータとして String のみがサポートされています。

    • ServerSentEventHttpMessageReader

      public ServerSentEventHttpMessageReader(@Nullable Decoder<?> decoder)
      オブジェクトにデコードするための JSON Decoder を持つコンストラクター。String イベントデータへのデコードのサポートが組み込まれています。

  • メソッドの詳細

    • getDecoder

      @Nullable public Decoder<?> 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

      public ListSE<MediaType> getReadableMediaTypes()
      インターフェースからコピーされた説明: HttpMessageReader
      このリーダーでサポートされているメディア型のリストを返します。このリストは、考えられるすべてのターゲット要素型に適用されるとは限らないため、このメソッドの呼び出しは通常、canWrite(elementType, null) を介して保護する必要があります。このリストでは、特定の要素型でのみサポートされているメディア型を除外することもできます。または、HttpMessageReader.getReadableMediaTypes(ResolvableType) を使用してより正確なリストを作成します。
      次で指定:
      インターフェース HttpMessageReader<ObjectSE> の getReadableMediaTypes 
      戻り値:
      サポートされているメディア型の一般的なリスト

    • canRead

      public boolean canRead(ResolvableType elementType, @Nullable MediaType mediaType)
      インターフェースからコピーされた説明: 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 - 入力の読み取りおよびデコード方法に関する追加情報
      戻り値:
      デコードされたオブジェクト