Package org.apache.pekko.http.scaladsl.common

Class EntityStreamingSupport$

java.lang.Object

org.apache.pekko.http.scaladsl.common.EntityStreamingSupport$

public class EntityStreamingSupport$
extends Object

Entity streaming support, independent of used Json parsing library etc.

Field Summary

Fields

Modifier and Type	Field	Description
static final EntityStreamingSupport$	MODULE$	Static reference to the singleton instance of this Scala object.

Constructor Summary

Constructors

Constructor	Description
EntityStreamingSupport$()

Method Summary

Modifier and Type	Method	Description
CsvEntityStreamingSupport	csv()	Default text/csv(UTF-8) entity streaming support.
CsvEntityStreamingSupport	csv(int maxLineLength)	Default text/csv(UTF-8) entity streaming support.
JsonEntityStreamingSupport	json()	Default application/json entity streaming support.
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

Field Details

MODULE$

public static final EntityStreamingSupport$ MODULE$

Static reference to the singleton instance of this Scala object.

Constructor Details

EntityStreamingSupport$

public EntityStreamingSupport$()

Method Details

json

public 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 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)

csv

public CsvEntityStreamingSupport csv()

Default text/csv(UTF-8) entity streaming support. Provides framing and rendering of \n separated lines and marshalling Sources into such values.

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

Returns:

(undocumented)

csv

public CsvEntityStreamingSupport csv(int maxLineLength)

Default text/csv(UTF-8) entity streaming support. Provides framing and rendering of \n separated lines and marshalling Sources into such values.

Parameters:

maxLineLength - (undocumented)

Returns:

(undocumented)