Package io.netty.handler.codec.http
Class HttpChunkedInput
java.lang.Object
io.netty.handler.codec.http.HttpChunkedInput
- All Implemented Interfaces:
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); }
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final ChunkedInput
<ByteBuf> private final LastHttpContent
private boolean
-
Constructor Summary
ConstructorsConstructorDescriptionHttpChunkedInput
(ChunkedInput<ByteBuf> input) Creates a new instance using the specified input.HttpChunkedInput
(ChunkedInput<ByteBuf> input, LastHttpContent lastHttpContent) Creates a new instance using the specified input. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Releases the resources associated with the input.boolean
Returntrue
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.readChunk
(ByteBufAllocator allocator) Fetches a chunked data from the stream.Deprecated.
-
Field Details
-
input
-
lastHttpContent
-
sentLastChunk
private boolean sentLastChunk
-
-
Constructor Details
-
HttpChunkedInput
Creates a new instance using the specified input.- Parameters:
input
-ChunkedInput
containing data to write
-
HttpChunkedInput
Creates a new instance using the specified input.lastHttpContent
will be written as the terminating chunk.- Parameters:
input
-ChunkedInput
containing data to writelastHttpContent
-LastHttpContent
that will be written as the terminating chunk. Use this for training headers.
-
-
Method Details
-
isEndOfInput
Description copied from interface:ChunkedInput
Returntrue
if and only if there is no data left in the stream and the stream has reached at its end.- Specified by:
isEndOfInput
in interfaceChunkedInput<HttpContent>
- Throws:
Exception
-
close
Description copied from interface:ChunkedInput
Releases the resources associated with the input.- Specified by:
close
in interfaceChunkedInput<HttpContent>
- Throws:
Exception
-
readChunk
Deprecated.- Specified by:
readChunk
in interfaceChunkedInput<HttpContent>
- Parameters:
ctx
- The context which provides aByteBufAllocator
if buffer allocation is necessary.- Returns:
- the fetched chunk.
null
if there is no data left in the stream. Please note thatnull
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
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 subsequentChunkedInput.isEndOfInput()
call must returntrue
.- Specified by:
readChunk
in interfaceChunkedInput<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 thatnull
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
public long length()Description copied from interface:ChunkedInput
Returns the length of the input.- Specified by:
length
in interfaceChunkedInput<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.
-
progress
public long progress()Description copied from interface:ChunkedInput
Returns current transfer progress.- Specified by:
progress
in interfaceChunkedInput<HttpContent>
-