public interface RecordParser extends Handler<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 . |
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.
|
static RecordParser |
newDelimited(Buffer delim,
Handler<Buffer> output)
Create a new
RecordParser instance, initially in delimited mode, and where the delimiter can be represented
by the Buffer delim. |
static RecordParser |
newDelimited(String delim,
Handler<Buffer> output)
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 |
newFixed(int size,
Handler<Buffer> output)
Create a new
RecordParser instance, initially in fixed size mode, and where the record size is specified
by the size parameter. |
void |
setOutput(Handler<Buffer> output) |
static RecordParser newDelimited(String delim, Handler<Buffer> output)
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 stringoutput
- handler that will receive the outputstatic RecordParser newDelimited(Buffer delim, Handler<Buffer> output)
RecordParser
instance, initially in delimited mode, and where the delimiter can be represented
by the Buffer
delim.
output
Will receive whole records which have been parsed.
delim
- the initial delimiter bufferoutput
- handler that will receive the outputstatic RecordParser newFixed(int size, Handler<Buffer> output)
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 sizeoutput
- handler that will receive the outputvoid 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 sizeCopyright © 2015. All Rights Reserved.