Values
end_arrayshared end_array end_array

Signals the end of a JSON array.

end_objectshared end_object end_object

Signals the end of a JSON object.

jsonEventTypeshared jsonEventType jsonEventType
jsonParsershared jsonParser jsonParser
recordParsershared recordParser recordParser
start_arrayshared start_array start_array

Signals the start of a JSON array.

start_objectshared start_object start_object

Signals the start of a JSON object.

valueshared value value

Signals a JSON value.

Classes
JsonEventshared JsonEvent

A JSON event emited by the JsonParser.

JsonEventTypeshared abstract JsonEventType

The possibles types of JsonEvent emitted by the JsonParser.

JsonParsershared JsonParser

A parser class which allows to incrementally parse json elements and emit json parse events instead of parsing a json element fully. This parser is convenient for parsing large json structures.

The parser also parses concatenated json streams or line delimited json streams.

The parser can also parse entire object or array when it is convenient, for instance a very large array of small objects can be parsed efficiently by handling array start/end and object events.

Whenever the parser fails to parse or process the stream, the exceptionHandler is called with the cause of the failure and the current handling stops. After such event, the parser should not handle data anymore.

RecordParsershared RecordParser

A helper class which allows you to easily parse protocols which are delimited by a sequence of bytes, or fixed size records.

Instances of this class take as input Buffer instances containing raw bytes, and output records.

For example, if I had a simple ASCII text protocol delimited by ' ' and the input was the following:

 buffer1:HELLO
HOW ARE Y
 buffer2:OU?
I AM
 buffer3: DOING OK
 buffer4:

 

Then the output would be:

 buffer1:HELLO
 buffer2:HOW ARE YOU?
 buffer3:I AM DOING OK
 

Instances of this class can be changed between delimited mode and fixed size record mode on the fly as individual records are read, this allows you to parse protocols where, for example, the first 5 records might all be fixed size (of potentially different sizes), followed by some delimited records, followed by more fixed size records.

Instances of this class can't currently be used for protocols where the text is encoded with something other than a 1-1 byte-char mapping.

Please see the documentation for more information.

end_arrayshared end_array

Signals the end of a JSON array.

end_objectshared end_object

Signals the end of a JSON object.

jsonEventTypeshared jsonEventType
jsonParsershared jsonParser
recordParsershared recordParser
start_arrayshared start_array

Signals the start of a JSON array.

start_objectshared start_object

Signals the start of a JSON object.

valueshared value

Signals a JSON value.