public interface RecordParser extends Handler<Buffer>, ReadStream<Buffer>
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 '\n' and the input was the following:
buffer1:HELLO\nHOW ARE Y buffer2:OU?\nI AM buffer3: DOING OK buffer4:\nThen the output would be:
buffer1:HELLO buffer2:HOW ARE YOU? buffer3:I AM DOING OKInstances 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.
| Modifier and Type | Method and Description |
|---|---|
void |
delimitedMode(Buffer delim)
Flip the parser into delimited mode, and where the delimiter can be represented
by the delimiter
delim. |
void |
delimitedMode(String delim)
Flip the parser into delimited mode, and where the delimiter can be represented
by the String
delim encoded in latin-1 . |
RecordParser |
endHandler(Handler<Void> endHandler)
Set an end handler.
|
RecordParser |
exceptionHandler(Handler<Throwable> handler)
Set an exception handler on the read stream.
|
RecordParser |
fetch(long amount)
Fetch the specified
amount of elements. |
void |
fixedSizeMode(int size)
Flip the parser into fixed size mode, where the record size is specified by
size in bytes. |
void |
handle(Buffer buffer)
This method is called to provide the parser with data.
|
RecordParser |
handler(Handler<Buffer> handler)
Set a data handler.
|
RecordParser |
maxRecordSize(int size)
Set the maximum allowed size for a record when using the delimited mode.
|
static RecordParser |
newDelimited(Buffer delim)
Create a new
RecordParser instance, initially in delimited mode, and where the delimiter can be represented
by the Buffer delim. |
static RecordParser |
newDelimited(Buffer delim,
Handler<Buffer> output)
Like
newDelimited(Buffer) but set the output that will receive whole records
which have been parsed. |
static RecordParser |
newDelimited(Buffer delim,
ReadStream<Buffer> stream)
Like
newDelimited(Buffer) but wraps the stream. |
static RecordParser |
newDelimited(String delim)
Create a new
RecordParser instance, initially in delimited mode, and where the delimiter can be represented
by the String delim endcoded in latin-1 . |
static RecordParser |
newDelimited(String delim,
Handler<Buffer> output)
Like
newDelimited(String) but set the output that will receive whole records
which have been parsed. |
static RecordParser |
newDelimited(String delim,
ReadStream<Buffer> stream)
Like
newDelimited(String) but wraps the stream. |
static RecordParser |
newFixed(int size)
Create a new
RecordParser instance, initially in fixed size mode, and where the record size is specified
by the size parameter. |
static RecordParser |
newFixed(int size,
Handler<Buffer> output)
Like
newFixed(int) but set the output that will receive whole records
which have been parsed. |
static RecordParser |
newFixed(int size,
ReadStream<Buffer> stream)
Like
newFixed(int) but wraps the stream. |
RecordParser |
pause()
Pause the
ReadStream, it sets the buffer in fetch mode and clears the actual demand. |
RecordParser |
resume()
Resume reading, and sets the buffer in
flowing mode. |
void |
setOutput(Handler<Buffer> output) |
pipe, pipeTo, pipeTostatic RecordParser newDelimited(String delim, Handler<Buffer> output)
newDelimited(String) but set the output that will receive whole records
which have been parsed.delim - the initial delimiter stringoutput - handler that will receive the outputstatic RecordParser newDelimited(String delim, ReadStream<Buffer> stream)
newDelimited(String) but wraps the stream. The stream handlers will be set/unset
when the handler(Handler) is set.
The pause()/resume() operations are propagated to the stream.delim - the initial delimiter stringstream - the wrapped streamstatic RecordParser newDelimited(String delim)
RecordParser instance, initially in delimited mode, and where the delimiter can be represented
by the String delim endcoded in latin-1 . Don't use this if your String contains other than latin-1 characters.
output Will receive whole records which have been parsed.
delim - the initial delimiter stringstatic RecordParser newDelimited(Buffer delim)
RecordParser instance, initially in delimited mode, and where the delimiter can be represented
by the Buffer delim.
delim - the initial delimiter bufferstatic RecordParser newDelimited(Buffer delim, Handler<Buffer> output)
newDelimited(Buffer) but set the output that will receive whole records
which have been parsed.delim - the initial delimiter bufferoutput - handler that will receive the outputstatic RecordParser newDelimited(Buffer delim, ReadStream<Buffer> stream)
newDelimited(Buffer) but wraps the stream. The stream handlers will be set/unset
when the handler(Handler) is set.
The pause()/resume() operations are propagated to the stream.delim - the initial delimiter bufferstream - the wrapped streamstatic RecordParser newFixed(int size)
RecordParser instance, initially in fixed size mode, and where the record size is specified
by the size parameter.
output Will receive whole records which have been parsed.
size - the initial record sizestatic RecordParser newFixed(int size, Handler<Buffer> output)
newFixed(int) but set the output that will receive whole records
which have been parsed.size - the initial record sizeoutput - handler that will receive the outputstatic RecordParser newFixed(int size, ReadStream<Buffer> stream)
newFixed(int) but wraps the stream. The stream handlers will be set/unset
when the handler(Handler) is set.
The pause()/resume() operations are propagated to the stream.size - the initial record sizestream - the wrapped streamvoid delimitedMode(String delim)
delim encoded in latin-1 . Don't use this if your String contains other than latin-1 characters.
This method can be called multiple times with different values of delim while data is being parsed.
delim - the new delimetervoid delimitedMode(Buffer delim)
delim.
This method can be called multiple times with different values of delim while data is being parsed.
delim - the new delimitervoid fixedSizeMode(int size)
size in bytes.
This method can be called multiple times with different values of size while data is being parsed.
size - the new record sizeRecordParser maxRecordSize(int size)
If a record is longer than specified, an IllegalStateException will be thrown.
size - the maximum record sizevoid handle(Buffer buffer)
RecordParser exceptionHandler(Handler<Throwable> handler)
ReadStreamexceptionHandler in interface ReadStream<Buffer>exceptionHandler in interface StreamBasehandler - the exception handlerRecordParser handler(Handler<Buffer> handler)
ReadStreamhandler in interface ReadStream<Buffer>RecordParser pause()
ReadStreamReadStream, it sets the buffer in fetch mode and clears the actual demand.
While it's paused, no data will be sent to the data handler.
pause in interface ReadStream<Buffer>RecordParser fetch(long amount)
ReadStreamamount of elements. If the ReadStream has been paused, reading will
recommence with the specified amount of items, otherwise the specified amount will
be added to the current stream demand.fetch in interface ReadStream<Buffer>RecordParser resume()
ReadStreamflowing mode.
If the ReadStream has been paused, reading will recommence on it.resume in interface ReadStream<Buffer>RecordParser endHandler(Handler<Void> endHandler)
ReadStreamendHandler in interface ReadStream<Buffer>Copyright © 2023 Eclipse. All rights reserved.