Click or drag to resize
Akka.NETJsonFraming Class
Provides JSON framing stages that can separate valid JSON objects from incoming ByteString objects.
Inheritance Hierarchy
SystemObject
  Akka.Streams.DslJsonFraming

Namespace:  Akka.Streams.Dsl
Assembly:  Akka.Streams (in Akka.Streams.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
public static class JsonFraming

The JsonFraming type exposes the following members.

Methods
  NameDescription
Public methodStatic memberObjectScanner
Returns a Flow that implements a "brace counting" based framing stage for emitting valid JSON chunks. It scans the incoming data stream for valid JSON objects and returns chunks of ByteStrings containing only those valid chunks. Typical examples of data that one may want to frame using this stage include:

**Very large arrays**: {{{ [{"id": 1}, {"id": 2}, [...], {"id": 999}] }}}

**Multiple concatenated JSON objects** (with, or without commas between them): {{{ {"id": 1}, {"id": 2}, [...], {"id": 999} }}}

The framing works independently of formatting, i.e. it will still emit valid JSON elements even if two elements are separated by multiple newlines or other whitespace characters. And of course is insensitive (and does not impact the emitting frame) to the JSON object's internal formatting.
Top
See Also