public class ChunkedStream extends java.lang.Object implements ChunkedInput<ByteBuf>
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.
| Modifier and Type | Field and Description |
|---|---|
private int |
chunkSize |
private boolean |
closed |
(package private) static int |
DEFAULT_CHUNK_SIZE |
private java.io.PushbackInputStream |
in |
private long |
offset |
| Constructor and 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.
|
| 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. |
long |
length()
Returns the length of the input.
|
long |
progress()
Returns current transfer progress.
|
ByteBuf |
readChunk(ByteBufAllocator allocator)
Fetches a chunked data from the stream.
|
ByteBuf |
readChunk(ChannelHandlerContext ctx)
Deprecated.
|
long |
transferredBytes()
Returns the number of transferred bytes.
|
static final int DEFAULT_CHUNK_SIZE
private final java.io.PushbackInputStream in
private final int chunkSize
private long offset
private boolean closed
public ChunkedStream(java.io.InputStream in)
public ChunkedStream(java.io.InputStream in,
int chunkSize)
chunkSize - the number of bytes to fetch on each
readChunk(ChannelHandlerContext) callpublic long transferredBytes()
public boolean isEndOfInput()
throws java.lang.Exception
ChunkedInputtrue if and only if there is no data left in the stream
and the stream has reached at its end.isEndOfInput in interface ChunkedInput<ByteBuf>java.lang.Exceptionpublic void close()
throws java.lang.Exception
ChunkedInputclose in interface ChunkedInput<ByteBuf>java.lang.Exception@Deprecated public ByteBuf readChunk(ChannelHandlerContext ctx) throws java.lang.Exception
readChunk in interface ChunkedInput<ByteBuf>ctx - The context which provides a ByteBufAllocator if buffer allocation is necessary.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.java.lang.Exceptionpublic ByteBuf readChunk(ByteBufAllocator allocator) throws java.lang.Exception
ChunkedInputChunkedInput.isEndOfInput()
call must return true.readChunk in interface ChunkedInput<ByteBuf>allocator - ByteBufAllocator if buffer allocation is necessary.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.java.lang.Exceptionpublic long length()
ChunkedInputlength in interface ChunkedInput<ByteBuf>public long progress()
ChunkedInputprogress in interface ChunkedInput<ByteBuf>