Package io.netty.handler.codec.http

Class HttpChunkedInput

  • All Implemented Interfaces:
    ChunkedInput<HttpContent>
    public class HttpChunkedInput
extends java.lang.Object
implements ChunkedInput<HttpContent>
    A ChunkedInput that fetches data chunk by chunk for use with HTTP chunked transfers.

    Each chunk from the input data will be wrapped within a HttpContent. At the end of the input data, LastHttpContent will be written.

    Ensure that your HTTP response header contains Transfer-Encoding: chunked. 

     public void messageReceived(ChannelHandlerContext ctx, FullHttpRequest request) throws Exception {
     HttpResponse response = new DefaultHttpResponse(HTTP_1_1, OK);
     response.headers().set(TRANSFER_ENCODING, CHUNKED);
     ctx.write(response);

     HttpChunkedInput httpChunkWriter = new HttpChunkedInput(
         new ChunkedFile("/tmp/myfile.txt"));
     ChannelFuture sendFileFuture = ctx.write(httpChunkWriter);
 }

    • Constructor Detail

      • HttpChunkedInput

        public HttpChunkedInput​(ChunkedInput<ByteBuf> input)
        Creates a new instance using the specified input.
        Parameters:
        input - ChunkedInput containing data to write

      • HttpChunkedInput

        public HttpChunkedInput​(ChunkedInput<ByteBuf> input,
                        LastHttpContent lastHttpContent)
        Creates a new instance using the specified input. lastHttpContent will be written as the terminating chunk.
        Parameters:
        input - ChunkedInput containing data to write
        lastHttpContent - LastHttpContent that will be written as the terminating chunk. Use this for training headers.

    • Method Detail

      • 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<HttpContent>
        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<HttpContent>
        Throws:
        java.lang.Exception

      • readChunk

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