Package org.jboss.netty.handler.stream
Class ChunkedStream
- java.lang.Object
-
- org.jboss.netty.handler.stream.ChunkedStream
-
- All Implemented Interfaces:
ChunkedInput
public class ChunkedStream extends java.lang.Object implements ChunkedInput
AChunkedInput
that fetches data from anInputStream
chunk by chunk.Please note that the
InputStream
instance that feeds data intoChunkedStream
must implementInputStream.available()
as accurately as possible, rather than using the default implementation. Otherwise,ChunkedStream
will generate many too small chunks or block unnecessarily often.
-
-
Field Summary
Fields Modifier and Type Field Description private int
chunkSize
(package private) static int
DEFAULT_CHUNK_SIZE
private java.io.PushbackInputStream
in
private long
offset
-
Constructor Summary
Constructors Constructor Description ChunkedStream(java.io.InputStream in)
Creates a new instance that fetches data from the specified stream.ChunkedStream(java.io.InputStream in, int chunkSize)
Creates a new instance that fetches data from the specified stream.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
close()
Releases the resources associated with the stream.long
getTransferredBytes()
Returns the number of transferred bytes.boolean
hasNextChunk()
Returnstrue
if and only if there is any data left in the stream.boolean
isEndOfInput()
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.java.lang.Object
nextChunk()
Fetches a chunked data from the stream.
-
-
-
Field Detail
-
DEFAULT_CHUNK_SIZE
static final int DEFAULT_CHUNK_SIZE
- See Also:
- Constant Field Values
-
in
private final java.io.PushbackInputStream in
-
chunkSize
private final int chunkSize
-
offset
private long offset
-
-
Constructor Detail
-
ChunkedStream
public ChunkedStream(java.io.InputStream in)
Creates a new instance that fetches data from the specified stream.
-
ChunkedStream
public ChunkedStream(java.io.InputStream in, int chunkSize)
Creates a new instance that fetches data from the specified stream.- Parameters:
chunkSize
- the number of bytes to fetch on eachnextChunk()
call
-
-
Method Detail
-
getTransferredBytes
public long getTransferredBytes()
Returns the number of transferred bytes.
-
hasNextChunk
public boolean hasNextChunk() throws java.lang.Exception
Description copied from interface:ChunkedInput
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.- Specified by:
hasNextChunk
in interfaceChunkedInput
- Throws:
java.lang.Exception
-
isEndOfInput
public boolean isEndOfInput() throws java.lang.Exception
Description copied from interface:ChunkedInput
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.- Specified by:
isEndOfInput
in interfaceChunkedInput
- Throws:
java.lang.Exception
-
close
public void close() throws java.lang.Exception
Description copied from interface:ChunkedInput
Releases the resources associated with the stream.- Specified by:
close
in interfaceChunkedInput
- Throws:
java.lang.Exception
-
nextChunk
public java.lang.Object nextChunk() throws java.lang.Exception
Description copied from interface:ChunkedInput
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 subsequentChunkedInput.isEndOfInput()
call must returnfalse
.- Specified by:
nextChunk
in interfaceChunkedInput
- 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:
java.lang.Exception
-
-