io.netty.handler.codec.http

类 HttpChunkedInput

java.lang.Object

io.netty.handler.codec.http.HttpChunkedInput

所有已实现的接口:

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);
 }
 

构造器概要

构造器

构造器和说明
HttpChunkedInput(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.

方法概要

限定符和类型	方法和说明
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.
HttpContent	readChunk(ByteBufAllocator allocator) Fetches a chunked data from the stream.
HttpContent	readChunk(ChannelHandlerContext ctx) 已过时。

从类继承的方法 java.lang.Object

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

构造器详细资料

HttpChunkedInput

public HttpChunkedInput(ChunkedInput<ByteBuf> input)

Creates a new instance using the specified input.

参数:

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.

参数:

input - ChunkedInput containing data to write

lastHttpContent - LastHttpContent that will be written as the terminating chunk. Use this for training headers.

方法详细资料

isEndOfInput

public boolean isEndOfInput()
                     throws java.lang.Exception

从接口复制的说明: ChunkedInput

Return true if and only if there is no data left in the stream and the stream has reached at its end.

指定者:

isEndOfInput 在接口中 ChunkedInput<HttpContent>

抛出:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

从接口复制的说明: ChunkedInput

Releases the resources associated with the input.

指定者:

close 在接口中 ChunkedInput<HttpContent>

抛出:

java.lang.Exception

readChunk

@Deprecated
public HttpContent readChunk(ChannelHandlerContext ctx)
                                   throws java.lang.Exception

已过时。

指定者:

readChunk 在接口中 ChunkedInput<HttpContent>

参数:

ctx - The context which provides a ByteBufAllocator if buffer allocation is necessary.

返回:

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.

抛出:

java.lang.Exception

readChunk

public HttpContent readChunk(ByteBufAllocator allocator)
                      throws java.lang.Exception

从接口复制的说明: 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.

指定者:

readChunk 在接口中 ChunkedInput<HttpContent>

参数:

allocator - ByteBufAllocator if buffer allocation is necessary.

返回:

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.

抛出:

java.lang.Exception

length

public long length()

从接口复制的说明: ChunkedInput

Returns the length of the input.

指定者:

length 在接口中 ChunkedInput<HttpContent>

返回:

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()

从接口复制的说明: ChunkedInput

Returns current transfer progress.

指定者:

progress 在接口中 ChunkedInput<HttpContent>