Package io.netty.handler.stream
Interface ChunkedInput<B>
-
- All Known Implementing Classes:
ChunkedFile
,ChunkedNioFile
,ChunkedNioStream
,ChunkedStream
,Http2DataChunkedInput
,HttpChunkedInput
,HttpPostRequestEncoder
,WebSocketChunkedInput
public interface ChunkedInput<B>
A data stream of indefinite length which is consumed byChunkedWriteHandler
.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
close()
Releases the resources associated with the input.boolean
isEndOfInput()
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.B
readChunk(ByteBufAllocator allocator)
Fetches a chunked data from the stream.B
readChunk(ChannelHandlerContext ctx)
Deprecated.
-
-
-
Method Detail
-
isEndOfInput
boolean isEndOfInput() throws java.lang.Exception
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.- Throws:
java.lang.Exception
-
close
void close() throws java.lang.Exception
Releases the resources associated with the input.- Throws:
java.lang.Exception
-
readChunk
@Deprecated B readChunk(ChannelHandlerContext ctx) throws java.lang.Exception
Deprecated.UsereadChunk(ByteBufAllocator)
.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 returntrue
.- 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:
java.lang.Exception
-
readChunk
B readChunk(ByteBufAllocator allocator) throws java.lang.Exception
Fetches a chunked data from the stream. Once this method returns the last chunk and thus the stream has reached at its end, any subsequentisEndOfInput()
call must returntrue
.- 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:
java.lang.Exception
-
length
long length()
Returns the length of the input.- 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
long progress()
Returns current transfer progress.
-
-