Top Description Fields Constructors Methods
io.netty.handler.stream

public Class ChunkedStream

extends Object
implements ChunkedInput<ByteBuf>
Class Inheritance
All Implemented Interfaces
io.netty.handler.stream.ChunkedInput
Imports
io.netty.buffer.ByteBuf, .ByteBufAllocator, io.netty.channel.ChannelHandlerContext, io.netty.util.internal.ObjectUtil, java.io.InputStream, .PushbackInputStream
A ChunkedInput that fetches data from an InputStream chunk by chunk.

Please note that the InputStream instance that feeds data into ChunkedStream must implement InputStream#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

Modifier and TypeField and Description
private final int
chunkSize

private boolean
closed

pack-priv static final int
DEFAULT_CHUNK_SIZE

private final PushbackInputStream
in

private long
offset

Constructor Summary

AccessConstructor and Description
public
ChunkedStream(InputStream in)

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

public
ChunkedStream(InputStream in, int
the number of bytes to fetch on each readChunk(ChannelHandlerContext) call
chunkSize)

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

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements io.netty.handler.stream.ChunkedInput.close.

Releases the resources associated with the input.
public boolean
isEndOfInput()

Implements io.netty.handler.stream.ChunkedInput.isEndOfInput.

Return true if and only if there is no data left in the stream and the stream has reached at its end.
public long
length()

Implements io.netty.handler.stream.ChunkedInput.length.

Returns the length of the input.
public long
progress()

Implements io.netty.handler.stream.ChunkedInput.progress.

Returns current transfer progress.
public ByteBuf
readChunk(ChannelHandlerContext
The context which provides a ByteBufAllocator if buffer allocation is necessary.
ctx)

Implements io.netty.handler.stream.ChunkedInput.readChunk.

Deprecated
public ByteBuf
readChunk(ByteBufAllocator
ByteBufAllocator if buffer allocation is necessary.
allocator)

Implements io.netty.handler.stream.ChunkedInput.readChunk.

Fetches a chunked data from the stream.
public long
transferredBytes()

Returns the number of transferred bytes.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

chunkSizeback to summary
private final int chunkSize
closedback to summary
private boolean closed
DEFAULT_CHUNK_SIZEback to summary
pack-priv static final int DEFAULT_CHUNK_SIZE
inback to summary
private final PushbackInputStream in
offsetback to summary
private long offset

Constructor Detail

ChunkedStreamback to summary
public ChunkedStream(InputStream in)

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

ChunkedStreamback to summary
public ChunkedStream(InputStream in, int chunkSize)

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

Parameters
chunkSize:int

the number of bytes to fetch on each readChunk(ChannelHandlerContext) call

Method Detail

closeback to summary
public void close() throws Exception

Implements io.netty.handler.stream.ChunkedInput.close.

Doc from io.netty.handler.stream.ChunkedInput.close.

Releases the resources associated with the input.

Annotations
@Override
isEndOfInputback to summary
public boolean isEndOfInput() throws Exception

Implements io.netty.handler.stream.ChunkedInput.isEndOfInput.

Doc from io.netty.handler.stream.ChunkedInput.isEndOfInput.

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

Annotations
@Override
lengthback to summary
public long length()

Implements io.netty.handler.stream.ChunkedInput.length.

Doc from io.netty.handler.stream.ChunkedInput.length.

Returns the length of the input.

Returns:long

the length of the input if the length of the input is known. a negative value if the length of the input is unknown.

Annotations
@Override
progressback to summary
public long progress()

Implements io.netty.handler.stream.ChunkedInput.progress.

Doc from io.netty.handler.stream.ChunkedInput.progress.

Returns current transfer progress.

Annotations
@Override
readChunkback to summary
public ByteBuf readChunk(ChannelHandlerContext ctx) throws Exception

Implements io.netty.handler.stream.ChunkedInput.readChunk.

Deprecated

Parameters
ctx:ChannelHandlerContext

Doc from io.netty.handler.stream.ChunkedInput.readChunk.

The context which provides a ByteBufAllocator if buffer allocation is necessary.

Returns:ByteBuf

Doc from io.netty.handler.stream.ChunkedInput.readChunk.

the fetched chunk. null if there is no data left in the stream. Please note that null does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.

Annotations
@Deprecated
@Override
readChunkback to summary
public ByteBuf readChunk(ByteBufAllocator allocator) throws Exception

Implements io.netty.handler.stream.ChunkedInput.readChunk.

Doc from io.netty.handler.stream.ChunkedInput.readChunk.

Fetches a chunked data from the stream. Once this method returns the last chunk and thus the stream has reached at its end, any subsequent isEndOfInput() call must return true.

Parameters
allocator:ByteBufAllocator

ByteBufAllocator if buffer allocation is necessary.

Returns:ByteBuf

the fetched chunk. null if there is no data left in the stream. Please note that null does not necessarily mean that the stream has reached at its end. In a slow stream, the next chunk might be unavailable just momentarily.

Annotations
@Override
transferredBytesback to summary
public long transferredBytes()

Returns the number of transferred bytes.