Package io.netty.handler.stream
Class ChunkedStream
java.lang.Object
io.netty.handler.stream.ChunkedStream
- All Implemented Interfaces:
ChunkedInput<ByteBuf>
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
FieldsModifier and TypeFieldDescriptionprivate final int
private boolean
(package private) static final int
private final PushbackInputStream
private long
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new instance that fetches data from the specified stream.ChunkedStream
(InputStream in, int chunkSize) Creates a new instance that fetches data from the specified stream. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Releases the resources associated with the input.boolean
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.long
length()
Returns the length of the input.long
progress()
Returns current transfer progress.readChunk
(ByteBufAllocator allocator) Fetches a chunked data from the stream.Deprecated.long
Returns the number of transferred bytes.
-
Field Details
-
DEFAULT_CHUNK_SIZE
static final int DEFAULT_CHUNK_SIZE- See Also:
-
in
-
chunkSize
private final int chunkSize -
offset
private long offset -
closed
private boolean closed
-
-
Constructor Details
-
ChunkedStream
Creates a new instance that fetches data from the specified stream. -
ChunkedStream
Creates a new instance that fetches data from the specified stream.- Parameters:
chunkSize
- the number of bytes to fetch on eachreadChunk(ChannelHandlerContext)
call
-
-
Method Details
-
transferredBytes
public long transferredBytes()Returns the number of transferred bytes. -
isEndOfInput
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<ByteBuf>
- Throws:
Exception
-
close
Description copied from interface:ChunkedInput
Releases the resources associated with the input.- Specified by:
close
in interfaceChunkedInput<ByteBuf>
- Throws:
Exception
-
readChunk
Deprecated.- Specified by:
readChunk
in interfaceChunkedInput<ByteBuf>
- Parameters:
ctx
- The context which provides aByteBufAllocator
if buffer allocation is necessary.- Returns:
- the fetched chunk.
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
-
readChunk
Description copied from interface:ChunkedInput
Fetches a chunked data from the stream. Once this method returns the last chunk and thus the stream has reached at its end, any subsequentChunkedInput.isEndOfInput()
call must returntrue
.- Specified by:
readChunk
in interfaceChunkedInput<ByteBuf>
- Parameters:
allocator
-ByteBufAllocator
if buffer allocation is necessary.- Returns:
- the fetched chunk.
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
-
length
public long length()Description copied from interface:ChunkedInput
Returns the length of the input.- Specified by:
length
in interfaceChunkedInput<ByteBuf>
- Returns:
- the length of the input if the length of the input is known. a negative value if the length of the input is unknown.
-
progress
public long progress()Description copied from interface:ChunkedInput
Returns current transfer progress.- Specified by:
progress
in interfaceChunkedInput<ByteBuf>
-