Class ChunkedStream

java.lang.Object
io.netty.handler.stream.ChunkedStream
All Implemented Interfaces:
ChunkedInput<ByteBuf>
public class ChunkedStream extends java.lang.Object implements ChunkedInput<ByteBuf>
A 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.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    chunkSize
     
    private boolean
    closed
     
    (package private) static final int
    DEFAULT_CHUNK_SIZE
     
    private final java.io.PushbackInputStream
    in
     
    private long
    offset
     

  • Constructor Summary

    Constructors
    Constructor
    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.

  • Method Summary

    Modifier and Type
    Method
    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.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • DEFAULT_CHUNK_SIZE

      static final int DEFAULT_CHUNK_SIZE
      See Also:

    • in

      private final java.io.PushbackInputStream in

    • chunkSize

      private final int chunkSize

    • offset

      private long offset

    • closed

      private boolean closed

  • Constructor Details

    • ChunkedStream

      public ChunkedStream(java.io.InputStream in)
      Creates a new instance that fetches data from the specified stream.

    • ChunkedStream

      public ChunkedStream(java.io.InputStream in, int chunkSize)
      Creates a new instance that fetches data from the specified stream.
      Parameters:
      chunkSize - the number of bytes to fetch on each readChunk(ChannelHandlerContext) call

  • Method Details

    • transferredBytes

      public long transferredBytes()
      Returns the number of transferred bytes.

    • isEndOfInput

      public boolean isEndOfInput() throws java.lang.Exception
      Description copied from interface: ChunkedInput
      Return true if and only if there is no data left in the stream and the stream has reached at its end.
      Specified by:
      isEndOfInput in interface ChunkedInput<ByteBuf>
      Throws:
      java.lang.Exception

    • close

      public void close() throws java.lang.Exception
      Description copied from interface: ChunkedInput
      Releases the resources associated with the input.
      Specified by:
      close in interface ChunkedInput<ByteBuf>
      Throws:
      java.lang.Exception

    • readChunk

      @Deprecated public ByteBuf readChunk(ChannelHandlerContext ctx) throws java.lang.Exception
      Deprecated.
      Specified by:
      readChunk in interface ChunkedInput<ByteBuf>
      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:
      java.lang.Exception

    • readChunk

      public ByteBuf readChunk(ByteBufAllocator allocator) throws java.lang.Exception
      Description copied from interface: ChunkedInput
      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 ChunkedInput.isEndOfInput() call must return true.
      Specified by:
      readChunk in interface ChunkedInput<ByteBuf>
      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:
      java.lang.Exception

    • length

      public long length()
      Description copied from interface: ChunkedInput
      Returns the length of the input.
      Specified by:
      length in interface ChunkedInput<ByteBuf>
      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

      public long progress()
      Description copied from interface: ChunkedInput
      Returns current transfer progress.
      Specified by:
      progress in interface ChunkedInput<ByteBuf>