ChunkedInput (Netty5/Handler 5.0.0.Alpha5 API)

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

ChunkedFile, ChunkedNioFile, ChunkedNioStream, ChunkedStream
```
public interface ChunkedInput<B>
extends AutoCloseable
```
A data stream of indefinite length which is consumed by ChunkedWriteHandler.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`B`	`readChunk(io.netty5.buffer.BufferAllocator allocator)`	Fetches a chunked data from the stream.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - isEndOfInput
```
boolean isEndOfInput()
              throws Exception
```
    Return true if and only if there is no data left in the stream and the stream has reached at its end.
    
    Throws:
    
    Exception
  - readChunk
```
B readChunk(io.netty5.buffer.BufferAllocator allocator)
     throws 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 subsequent isEndOfInput() call must return true.
    
    Parameters:
    
    allocator - BufferAllocator if buffer allocation is necessary.
    
    Returns:
    
    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.
    
    Throws:
    
    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.