Package org.apache.pekko.http.scaladsl.marshallers.sprayjson

Class SprayJsonEntityStreamingSupport

java.lang.Object
org.apache.pekko.http.scaladsl.marshallers.sprayjson.SprayJsonEntityStreamingSupport
public class SprayJsonEntityStreamingSupport extends Object
Entity streaming support, implemented using spray-json.

See also github.com/spray/spray-json for details about Spray JSON itself

  • Constructor Details

    • SprayJsonEntityStreamingSupport

      public SprayJsonEntityStreamingSupport()

  • Method Details

    • json

      public static JsonEntityStreamingSupport json()
      Default application/json entity streaming support.

      Provides framing (based on scanning the incoming dataBytes for valid JSON objects, so for example uploads using arrays or new-line separated JSON objects are all parsed correctly) and rendering of Sources as JSON Arrays. A different very popular style of returning streaming JSON is to separate JSON objects on a line-by-line basis, you can configure the support trait to do so by calling withFramingRendererFlow.

      Limits the maximum JSON object length to 8KB, if you want to increase this limit provide a value explicitly.

      See also https://en.wikipedia.org/wiki/JSON_Streaming

      Returns:
      (undocumented)

    • json

      public static JsonEntityStreamingSupport json(int maxObjectLength)
      Default application/json entity streaming support.

      Provides framing (based on scanning the incoming dataBytes for valid JSON objects, so for example uploads using arrays or new-line separated JSON objects are all parsed correctly) and rendering of Sources as JSON Arrays. A different very popular style of returning streaming JSON is to separate JSON objects on a line-by-line basis, you can configure the support trait to do so by calling withFramingRendererFlow.

      See also https://en.wikipedia.org/wiki/JSON_Streaming

      Parameters:
      maxObjectLength - (undocumented)
      Returns:
      (undocumented)