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

Class SprayJsonEntityStreamingSupport

java.lang.Object

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

public class SprayJsonEntityStreamingSupport
extends java.lang.Object

Entity streaming support, implemented using spray-json.

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

Constructor Summary

Constructors

Constructor and Description
SprayJsonEntityStreamingSupport()

Method Summary

Modifier and Type	Method and Description
static JsonEntityStreamingSupport	json() Default application/json entity streaming support.
static JsonEntityStreamingSupport	json(int maxObjectLength) Default application/json entity streaming support.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SprayJsonEntityStreamingSupport

public SprayJsonEntityStreamingSupport()

Method Detail

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)