Grizzly NIO 5.0.2 · org.glassfish.grizzly.InputSource

Method Summary

Modifier and Type	Method and Description
public boolean	isFinished() Returns: `true` when all data for this particular request has been read, otherwise returns `false`.
public boolean	isReady() Returns: `true` if data can be obtained without blocking, otherwise returns `false`.
public void	notifyAvailable(final ReadHandler the `ReadHandler` to notify. handler) Notify the specified `ReadHandler` when any number of bytes or characters can be read without blocking.
public void	notifyAvailable(final ReadHandler the `ReadHandler` to notify. handler, final int the least number of bytes that must be available before the `ReadHandler` is invoked. size) Notify the specified `ReadHandler` when the number of bytes that can be read without blocking is greater or equal to the specified `size`.
public int	readyData() Returns: the number of bytes (or characters) that may be obtained without blocking.

isFinished	back to summary
public boolean isFinished() Returns:boolean `true` when all data for this particular request has been read, otherwise returns `false`.

isReady	back to summary
public boolean isReady() Returns:boolean `true` if data can be obtained without blocking, otherwise returns `false`.

notifyAvailable back to summary

notifyAvailable	back to summary
public void notifyAvailable(final ReadHandler handler) Notify the specified `ReadHandler` when any number of bytes or characters can be read without blocking. Invoking this method is equivalent to calling: notifyAvailable(handler, 1). Parameters handler:ReadHandler the `ReadHandler` to notify. Exceptions IllegalArgumentException: if `handler` is `null`. IllegalStateException: if an attempt is made to register a handler before an existing registered handler has been invoked or if all request data has already been read. See Also `ReadHandler#onDataAvailable()`, `ReadHandler#onAllDataRead()`

public void notifyAvailable(final ReadHandler handler)

Notify the specified ReadHandler when any number of bytes or characters can be read without blocking.

Invoking this method is equivalent to calling: notifyAvailable(handler, 1).

Parameters

Exceptions

IllegalArgumentException:: if handler is null.
IllegalStateException:: if an attempt is made to register a handler before an existing registered handler has been invoked or if all request data has already been read.

notifyAvailable back to summary

notifyAvailable	back to summary
public void notifyAvailable(final ReadHandler handler, final int size) Notify the specified `ReadHandler` when the number of bytes that can be read without blocking is greater or equal to the specified `size`. Parameters handler:ReadHandler the `ReadHandler` to notify. size:int the least number of bytes that must be available before the `ReadHandler` is invoked. Exceptions IllegalArgumentException: if `handler` is `null`, or if `size` is less or equal to zero. IllegalStateException: if an attempt is made to register a handler before an existing registered handler has been invoked or if all request data has already been read. See Also `ReadHandler#onDataAvailable()`, `ReadHandler#onAllDataRead()`

public void notifyAvailable(final ReadHandler handler, final int size)

Notify the specified ReadHandler when the number of bytes that can be read without blocking is greater or equal to the specified size.

Parameters

handler:ReadHandler: the ReadHandler to notify.
size:int: the least number of bytes that must be available before the ReadHandler is invoked.

Exceptions

IllegalArgumentException:: if handler is null, or if size is less or equal to zero.
IllegalStateException:: if an attempt is made to register a handler before an existing registered handler has been invoked or if all request data has already been read.

readyData	back to summary
public int readyData() Returns:int the number of bytes (or characters) that may be obtained without blocking. Note when dealing with characters, this method may return an estimate on the number of characters available.