Package org.glassfish.grizzly
Interface InputSource
-
public interface InputSource
This interface defines methods to allow an
InputStream
orReader
to notify the developer when and how much data is ready to be read without blocking.- Since:
- 2.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
isFinished()
boolean
isReady()
void
notifyAvailable(ReadHandler handler)
Notify the specifiedReadHandler
when any number of bytes or characters can be read without blocking.void
notifyAvailable(ReadHandler handler, int size)
Notify the specifiedReadHandler
when the number of bytes that can be read without blocking is greater or equal to the specifiedsize
.int
readyData()
-
-
-
Method Detail
-
notifyAvailable
void notifyAvailable(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
- theReadHandler
to notify.- Throws:
IllegalArgumentException
- ifhandler
isnull
.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()
-
notifyAvailable
void notifyAvailable(ReadHandler handler, int size)
Notify the specified
ReadHandler
when the number of bytes that can be read without blocking is greater or equal to the specifiedsize
.- Parameters:
handler
- theReadHandler
to notify.size
- the least number of bytes that must be available before theReadHandler
is invoked.- Throws:
IllegalArgumentException
- ifhandler
isnull
, or ifsize
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()
-
isFinished
boolean isFinished()
- Returns:
true
when all data for this particular request has been read, otherwise returnsfalse
.
-
readyData
int readyData()
- Returns:
- 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.
-
isReady
boolean isReady()
- Returns:
true
if data can be obtained without blocking, otherwise returnsfalse
.
-
-