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 by ChunkedWriteHandler.

  • Method Details

    • 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

    • close

      void close() throws Exception
      Releases the resources associated with the input.
      Throws:
      Exception

    • readChunk

      @Deprecated B readChunk(ChannelHandlerContext ctx) throws Exception
      Deprecated.
      Use readChunk(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 return true.

      Parameters:
      ctx - The context which provides a ByteBufAllocator 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

    • readChunk

      B readChunk(ByteBufAllocator 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 - ByteBufAllocator 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.