Package org.jboss.netty.handler.stream
Interface ChunkedInput
- All Known Implementing Classes:
ChunkedFile
,ChunkedNioFile
,ChunkedNioStream
,ChunkedStream
,HttpPostRequestEncoder
public interface ChunkedInput
A data stream of indefinite length which is consumed by
ChunkedWriteHandler
.-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Releases the resources associated with the stream.boolean
Returnstrue
if and only if there is any data left in the stream.boolean
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.Fetches a chunked data from the stream.
-
Method Details
-
hasNextChunk
Returnstrue
if and only if there is any data left in the stream. Please note thatfalse
does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.- Throws:
Exception
-
nextChunk
Fetches a chunked data from the stream. The returned chunk is usually aChannelBuffer
, but you could extend an existing implementation to convert theChannelBuffer
into a different type that your handler or encoder understands. Once this method returns the last chunk and thus the stream has reached at its end, any subsequentisEndOfInput()
call must returnfalse
.- Returns:
- the fetched chunk, which is usually
ChannelBuffer
.null
if there is no data left in the stream. Please note thatnull
does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily. - Throws:
Exception
-
isEndOfInput
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.- Throws:
Exception
-
close
Releases the resources associated with the stream.- Throws:
Exception
-