Interface ChunkedInput

All Known Implementing Classes:
ChunkedFile, ChunkedNioFile, ChunkedNioStream, ChunkedStream, HttpPostRequestEncoder

public interface ChunkedInput
A data stream of indefinite length which is consumed by ChunkedWriteHandler.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Releases the resources associated with the stream.
    boolean
    Returns true if and only if there is any data left in the stream.
    boolean
    Return true if and only if there is no data left in the stream and the stream has reached at its end.
    Fetches a chunked data from the stream.
  • Method Details

    • hasNextChunk

      boolean hasNextChunk() throws Exception
      Returns true if and only if there is any data left in the stream. Please note that false 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
    • nextChunk

      Object nextChunk() throws Exception
      Fetches a chunked data from the stream. The returned chunk is usually a ChannelBuffer, but you could extend an existing implementation to convert the ChannelBuffer into a different type that your handler or encoder understands. Once this method returns the last chunk and thus the stream has reached at its end, any subsequent isEndOfInput() call must return false.
      Returns:
      the fetched chunk, which is usually ChannelBuffer. 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
    • 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 stream.
      Throws:
      Exception