Package org.jboss.netty.handler.stream
Class ChunkedNioStream
- java.lang.Object
-
- org.jboss.netty.handler.stream.ChunkedNioStream
-
- All Implemented Interfaces:
ChunkedInput
public class ChunkedNioStream extends java.lang.Object implements ChunkedInput
AChunkedInput
that fetches data from aReadableByteChannel
chunk by chunk. Please note that theReadableByteChannel
must operate in blocking mode. Non-blocking mode channels are not supported.
-
-
Field Summary
Fields Modifier and Type Field Description private java.nio.ByteBuffer
byteBuffer
Associated ByteBufferprivate int
chunkSize
private java.nio.channels.ReadableByteChannel
in
private long
offset
-
Constructor Summary
Constructors Constructor Description ChunkedNioStream(java.nio.channels.ReadableByteChannel in)
Creates a new instance that fetches data from the specified channel.ChunkedNioStream(java.nio.channels.ReadableByteChannel in, int chunkSize)
Creates a new instance that fetches data from the specified channel.
-
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.
-
-
-
Constructor Detail
-
ChunkedNioStream
public ChunkedNioStream(java.nio.channels.ReadableByteChannel in)
Creates a new instance that fetches data from the specified channel.
-
ChunkedNioStream
public ChunkedNioStream(java.nio.channels.ReadableByteChannel in, int chunkSize)
Creates a new instance that fetches data from the specified channel.- 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
-
-