Vert.x 4.5.13 · io.vertx.core.parsetools.impl.RecordParserImpl

Modifier and Type	Field and Description
private Buffer	buff References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element.
private byte[]	delim
private boolean	delimited
private int	delimPos
private long	demand
private static final Buffer	EMPTY_BUFFER References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element.
private Handler<Void>	endHandler
private Handler<Buffer>	eventHandler
private Handler<Throwable>	exceptionHandler
private int	maxRecordSize
private boolean	parsing
private int	pos
private int	recordSize
private int	start
private final ReadStream<Buffer>	stream
private boolean	streamEnded

Access	Constructor and Description
private	RecordParserImpl(ReadStream<Buffer> stream)

Method Summary

Modifier and Type	Method and Description
public void	delimitedMode(String the new delimeter delim) Implements io.vertx.core.parsetools.RecordParser.delimitedMode. Flip the parser into delimited mode, and where the delimiter can be represented by the String `delim` encoded in latin-1 .
public void	delimitedMode(Buffer the new delimiter delim) Implements io.vertx.core.parsetools.RecordParser.delimitedMode. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Flip the parser into delimited mode, and where the delimiter can be represented by the delimiter `delim`.
private void	end()
public RecordParser	endHandler(Handler<Void> handler) Implements io.vertx.core.parsetools.RecordParser.endHandler.
public RecordParser	exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.parsetools.RecordParser.exceptionHandler.
public RecordParser	fetch(long amount) Implements io.vertx.core.parsetools.RecordParser.fetch. Fetch the specified `amount` of elements.
public void	fixedSizeMode(int the new record size size) Implements io.vertx.core.parsetools.RecordParser.fixedSizeMode. Flip the parser into fixed size mode, where the record size is specified by `size` in bytes.
public void	handle(Buffer a chunk of data buffer) Implements io.vertx.core.parsetools.RecordParser.handle. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. This method is called to provide the parser with data.
private void	handleParsing()
public RecordParser	handler(Handler<Buffer> handler) Implements io.vertx.core.parsetools.RecordParser.handler.
public static Buffer	Returns: The byte[] form of the string latin1StringToBytes(String the string str) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Helper method to convert a latin-1 String to an array of bytes for use as a delimiter Please do not use this for non latin-1 characters
public RecordParser	Returns: a reference to this, so the API can be used fluently maxRecordSize(int the maximum record size size) Implements io.vertx.core.parsetools.RecordParser.maxRecordSize. Set the maximum allowed size for a record when using the delimited mode.
public static RecordParser	newDelimited(String the initial delimiter string delim, ReadStream<Buffer> stream, Handler<Buffer> handler that will receive the output 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 .
public static RecordParser	newDelimited(Buffer the initial delimiter buffer delim, ReadStream<Buffer> stream, Handler<Buffer> handler that will receive the output output) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. Create a new `RecordParser` instance, initially in delimited mode, and where the delimiter can be represented by the `buffer` delim.
public static RecordParser	newFixed(int the initial record size size, ReadStream<Buffer> stream, Handler<Buffer> handler that will receive the output output) Create a new `RecordParser` instance, initially in fixed size mode, and where the record size is specified by the `size` parameter.
private int	parseDelimited()
private int	parseFixed()
public RecordParser	pause() Implements io.vertx.core.parsetools.RecordParser.pause. Pause the `ReadStream`, it sets the buffer in `fetch` mode and clears the actual demand.
public RecordParser	resume() Implements io.vertx.core.parsetools.RecordParser.resume. Resume reading, and sets the buffer in `flowing` mode.
public void	setOutput(Handler<Buffer> output) Implements io.vertx.core.parsetools.RecordParser.setOutput.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

buff	back to summary
private Buffer buff References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

delim	back to summary
private byte[] delim

delimited	back to summary
private boolean delimited

delimPos	back to summary
private int delimPos

demand	back to summary
private long demand

EMPTY_BUFFER	back to summary
private static final Buffer EMPTY_BUFFER References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information.

endHandler	back to summary
private Handler<Void> endHandler

eventHandler	back to summary
private Handler<Buffer> eventHandler

exceptionHandler	back to summary
private Handler<Throwable> exceptionHandler

maxRecordSize	back to summary
private int maxRecordSize

parsing	back to summary
private boolean parsing

pos	back to summary
private int pos

recordSize	back to summary
private int recordSize

start	back to summary
private int start

stream	back to summary
private final ReadStream<Buffer> stream

streamEnded	back to summary
private boolean streamEnded

RecordParserImpl	back to summary
private RecordParserImpl(ReadStream<Buffer> stream)

Method Detail

delimitedMode back to summary

delimitedMode	back to summary
public void delimitedMode(String delim) Implements io.vertx.core.parsetools.RecordParser.delimitedMode. Flip the parser into delimited mode, and where the delimiter can be represented by the String `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. Parameters delim:String the new delimeter

public void delimitedMode(String delim)

Implements io.vertx.core.parsetools.RecordParser.delimitedMode.

Flip the parser into delimited mode, and where the delimiter can be represented by the String 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.

Parameters

delim:String: the new delimeter

delimitedMode back to summary

delimitedMode	back to summary
public void delimitedMode(Buffer delim) Implements io.vertx.core.parsetools.RecordParser.delimitedMode. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Flip the parser into delimited mode, and where the delimiter can be represented by the delimiter `delim`. This method can be called multiple times with different values of delim while data is being parsed. Parameters delim:Buffer the new delimiter

public void delimitedMode(Buffer delim)

Implements io.vertx.core.parsetools.RecordParser.delimitedMode.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Flip the parser into delimited mode, and where the delimiter can be represented by the delimiter delim.

This method can be called multiple times with different values of delim while data is being parsed.

Parameters

delim:Buffer: the new delimiter

end	back to summary
private void end()

endHandler	back to summary
public RecordParser endHandler(Handler<Void> handler) Implements io.vertx.core.parsetools.RecordParser.endHandler. Annotations @Override

endHandler

back to summary

public RecordParser endHandler(Handler<Void> handler)

Implements io.vertx.core.parsetools.RecordParser.endHandler.

Annotations

@Override

exceptionHandler	back to summary
public RecordParser exceptionHandler(Handler<Throwable> handler) Implements io.vertx.core.parsetools.RecordParser.exceptionHandler. Annotations @Override

exceptionHandler

back to summary

public RecordParser exceptionHandler(Handler<Throwable> handler)

Implements io.vertx.core.parsetools.RecordParser.exceptionHandler.

Annotations

@Override

fetch back to summary

fetch	back to summary
public RecordParser fetch(long amount) Implements io.vertx.core.parsetools.RecordParser.fetch. Doc from io.vertx.core.streams.ReadStream.fetch. Fetch the specified `amount` 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. Returns:RecordParser a reference to this, so the API can be used fluently Annotations @Override

public RecordParser fetch(long amount)

Implements io.vertx.core.parsetools.RecordParser.fetch.

Doc from io.vertx.core.streams.ReadStream.fetch.

Fetch the specified amount 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.

Returns:RecordParser

a reference to this, so the API can be used fluently

Annotations

@Override

fixedSizeMode back to summary

fixedSizeMode	back to summary
public void fixedSizeMode(int size) Implements io.vertx.core.parsetools.RecordParser.fixedSizeMode. Flip the parser into fixed size mode, where the record size is specified by `size` in bytes. This method can be called multiple times with different values of size while data is being parsed. Parameters size:int the new record size

public void fixedSizeMode(int size)

Implements io.vertx.core.parsetools.RecordParser.fixedSizeMode.

Flip the parser into fixed size mode, where the record size is specified by size in bytes.

This method can be called multiple times with different values of size while data is being parsed.

Parameters

size:int: the new record size

handle back to summary

handle	back to summary
public void handle(Buffer buffer) Implements io.vertx.core.parsetools.RecordParser.handle. References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. This method is called to provide the parser with data. Parameters buffer:Buffer a chunk of data

public void handle(Buffer buffer)

Implements io.vertx.core.parsetools.RecordParser.handle.

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

This method is called to provide the parser with data.

Parameters

buffer:Buffer: a chunk of data

handleParsing	back to summary
private void handleParsing()

handler	back to summary
public RecordParser handler(Handler<Buffer> handler) Implements io.vertx.core.parsetools.RecordParser.handler. Annotations @Override

handler

back to summary

public RecordParser handler(Handler<Buffer> handler)

Implements io.vertx.core.parsetools.RecordParser.handler.

Annotations

@Override

latin1StringToBytes back to summary

latin1StringToBytes	back to summary
public static Buffer latin1StringToBytes(String str) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Helper method to convert a latin-1 String to an array of bytes for use as a delimiter Please do not use this for non latin-1 characters Parameters str:String the string Returns:Buffer The byte[] form of the string

public static Buffer latin1StringToBytes(String str)

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Helper method to convert a latin-1 String to an array of bytes for use as a delimiter Please do not use this for non latin-1 characters

Parameters

str:String: the string

Returns:Buffer

The byte[] form of the string

maxRecordSize back to summary

maxRecordSize	back to summary
public RecordParser maxRecordSize(int size) Implements io.vertx.core.parsetools.RecordParser.maxRecordSize. Set the maximum allowed size for a record when using the delimited mode. The delimiter itself does not count for the record size. If a record is longer than specified, an `IllegalStateException` will be thrown. Parameters size:int the maximum record size Returns:RecordParser a reference to this, so the API can be used fluently

public RecordParser maxRecordSize(int size)

Implements io.vertx.core.parsetools.RecordParser.maxRecordSize.

Set the maximum allowed size for a record when using the delimited mode. The delimiter itself does not count for the record size.

If a record is longer than specified, an IllegalStateException will be thrown.

Parameters

size:int: the maximum record size

Returns:RecordParser

a reference to this, so the API can be used fluently

newDelimited back to summary

newDelimited	back to summary
public static RecordParser newDelimited(String delim, ReadStream<Buffer> stream, 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 . Don't use this if your String contains other than latin-1 characters. `output` Will receive whole records which have been parsed. Parameters delim:String the initial delimiter string output:Handler<Buffer> handler that will receive the output

public static RecordParser newDelimited(String delim, ReadStream<Buffer> stream, 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 . Don't use this if your String contains other than latin-1 characters.

output Will receive whole records which have been parsed.

Parameters

delim:String: the initial delimiter string
output:Handler<Buffer>: handler that will receive the output

newDelimited back to summary

newDelimited	back to summary
public static RecordParser newDelimited(Buffer delim, ReadStream<Buffer> stream, Handler<Buffer> output) References Deprecated `Buffer` is deprecated or references (maybe indirectly) at least one deprecated element. See corresponding docs for further information. Create a new `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. Parameters delim:Buffer the initial delimiter buffer output:Handler<Buffer> handler that will receive the output

public static RecordParser newDelimited(Buffer delim, ReadStream<Buffer> stream, Handler<Buffer> output)

References Deprecated

Buffer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Create a new 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.

Parameters

delim:Buffer: the initial delimiter buffer
output:Handler<Buffer>: handler that will receive the output

newFixed back to summary

newFixed	back to summary
public static RecordParser newFixed(int size, ReadStream<Buffer> stream, Handler<Buffer> output) Create a new `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. Parameters size:int the initial record size output:Handler<Buffer> handler that will receive the output

public static RecordParser newFixed(int size, ReadStream<Buffer> stream, Handler<Buffer> output)

Create a new 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.

Parameters

size:int: the initial record size
output:Handler<Buffer>: handler that will receive the output

parseDelimited	back to summary
private int parseDelimited()

parseFixed	back to summary
private int parseFixed()

pause back to summary

pause	back to summary
public RecordParser pause() Implements io.vertx.core.parsetools.RecordParser.pause. Doc from io.vertx.core.streams.ReadStream.pause. Pause the `ReadStream`, 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`. Returns:RecordParser a reference to this, so the API can be used fluently Annotations @Override

public RecordParser pause()

Implements io.vertx.core.parsetools.RecordParser.pause.

Doc from io.vertx.core.streams.ReadStream.pause.

Pause the ReadStream, 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.

Returns:RecordParser

a reference to this, so the API can be used fluently

Annotations

@Override

resume back to summary

resume	back to summary
public RecordParser resume() Implements io.vertx.core.parsetools.RecordParser.resume. Doc from io.vertx.core.streams.ReadStream.resume. Resume reading, and sets the buffer in `flowing` mode. If the `ReadStream` has been paused, reading will recommence on it. Returns:RecordParser a reference to this, so the API can be used fluently Annotations @Override

public RecordParser resume()

Implements io.vertx.core.parsetools.RecordParser.resume.

Doc from io.vertx.core.streams.ReadStream.resume.

Resume reading, and sets the buffer in flowing mode.

If the ReadStream has been paused, reading will recommence on it.

Returns:RecordParser

a reference to this, so the API can be used fluently

Annotations

@Override

setOutput	back to summary
public void setOutput(Handler<Buffer> output) Implements io.vertx.core.parsetools.RecordParser.setOutput.

public Class RecordParserImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail