io.netty.handler.stream

Class ChunkedNioStream

java.lang.Object

io.netty.handler.stream.ChunkedNioStream

All Implemented Interfaces:

ChunkedByteInput, ChunkedInput<ByteBuf>

public class ChunkedNioStream
extends Object
implements ChunkedByteInput

A ChunkedByteInput that fetches data from a ReadableByteChannel chunk by chunk. Please note that the ReadableByteChannel must operate in blocking mode. Non-blocking mode channels are not supported.

Constructor Summary

Constructors

Constructor and Description
ChunkedNioStream(ReadableByteChannel in) Creates a new instance that fetches data from the specified channel.
ChunkedNioStream(ReadableByteChannel in, int chunkSize) Creates a new instance that fetches data from the specified channel.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Releases the resources associated with the input.
boolean	isEndOfInput() Return true if and only if there is no data left in the stream and the stream has reached at its end.
boolean	readChunk(ByteBuf buffer) Fetches a chunked data from the stream.
long	transferredBytes() Returns the number of transferred bytes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ChunkedNioStream

public ChunkedNioStream(ReadableByteChannel in)

Creates a new instance that fetches data from the specified channel.

ChunkedNioStream

public ChunkedNioStream(ReadableByteChannel in,
                int chunkSize)

Creates a new instance that fetches data from the specified channel.

Parameters:

chunkSize - the number of bytes to fetch on each readChunk(ByteBuf) call

Method Detail

transferredBytes

public long transferredBytes()

Returns the number of transferred bytes.

isEndOfInput

public boolean isEndOfInput()
                     throws Exception

Description copied from interface: ChunkedInput

Return true if and only if there is no data left in the stream and the stream has reached at its end.

Specified by:

isEndOfInput in interface ChunkedInput<ByteBuf>

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: ChunkedInput

Releases the resources associated with the input.

Specified by:

close in interface ChunkedInput<ByteBuf>

Throws:

Exception

readChunk

public boolean readChunk(ByteBuf buffer)
                  throws Exception

Description copied from interface: ChunkedInput

Fetches a chunked data from the stream. The chunk is then transfered to the given buffer. Once this method returns the last chunk and thus the stream has reached at its end, any subsequent ChunkedInput.isEndOfInput() call must return false.

Specified by:

readChunk in interface ChunkedInput<ByteBuf>

Parameters:

buffer - read the next chunk and transfer it to the given buffer

Throws:

Exception