HttpChunkedInput (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.handler.codec.http.HttpChunkedInput

All Implemented Interfaces:: ChunkedInput < HttpContent >

public class HttpChunkedInput
extends java.lang.Object
implements ChunkedInput<HttpContent>

一个ChunkedInput ，通过块获取数据块以便与HTTP分块传输一起使用。

来自输入数据的每个块将被包装在HttpContent内。在输入数据的末尾，将写入LastHttpContent 。

确保您的HTTP响应标头包含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);

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

构造方法摘要

构造方法
Constructor and Description
`HttpChunkedInput(ChunkedInput<ByteBuf> input)` 使用指定的输入创建一个新实例。
`HttpChunkedInput(ChunkedInput<ByteBuf> input, LastHttpContent lastHttpContent)` 使用指定的输入创建一个新实例。

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`void`	`close()` 释放与输入相关的资源。
`boolean`	`isEndOfInput()` 返回 `true`当且仅当数据流中没有剩余数据且数据流已达到其结尾时。
`long`	`length()` 返回输入的长度。
`long`	`progress()` 返回当前传输进度。
`HttpContent`	`readChunk(ByteBufAllocator allocator)` 从流中获取分块的数据。
`HttpContent`	`readChunk(ChannelHandlerContext ctx)` 已过时。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造方法详细信息
  - HttpChunkedInput
```
public HttpChunkedInput(ChunkedInput<ByteBuf> input)
```
    使用指定的输入创建一个新实例。
    
    参数
    
    input - ChunkedInput包含要写入的数据
  - HttpChunkedInput
```
public HttpChunkedInput(ChunkedInput<ByteBuf> input,
                        LastHttpContent lastHttpContent)
```
    使用指定的输入创建一个新实例。 lastHttpContent将被写为终止块。
    
    参数
    
    input - ChunkedInput包含要写入的数据
    
    lastHttpContent - LastHttpContent将被写为终止块。使用它来训练标题。
- 方法详细信息
  - isEndOfInput
```
public boolean isEndOfInput()
                     throws java.lang.Exception
```
    从界面复制的描述： ChunkedInput
    
    返回 true当且仅当数据流中没有剩余数据并且数据流已达到其结尾时。
    
    Specified by:
    
    isEndOfInput在界面 ChunkedInput<HttpContent>
    
    异常
    
    java.lang.Exception
  - close
```
public void close()
           throws java.lang.Exception
```
    从界面复制的描述： ChunkedInput
    
    释放与输入相关的资源。
    
    Specified by:
    
    close在界面 ChunkedInput<HttpContent>
    
    异常
    
    java.lang.Exception
  - readChunk
```
@Deprecated
public HttpContent readChunk(ChannelHandlerContext ctx)
                                  throws java.lang.Exception
```
    已过时。
    
    Specified by:
    
    readChunk接口 ChunkedInput<HttpContent>
    
    参数
    
    ctx -它提供了一个上下文ByteBufAllocator如果缓冲区分配是必要的。
    
    结果
    
    获取的块。 null如果流中没有剩余数据。请注意， null并不一定意味着该流已达到其结尾。在缓慢的流中，下一个块可能暂时不可用。
    
    异常
    
    java.lang.Exception
  - readChunk
```
public HttpContent readChunk(ByteBufAllocator allocator)
                      throws java.lang.Exception
```
    从界面复制的描述： ChunkedInput
    
    从流中获取分块的数据。一旦此方法返回最后一个块并因此流到达末尾，任何后续的ChunkedInput.isEndOfInput()调用都必须返回true 。
    
    Specified by:
    
    readChunk在界面 ChunkedInput<HttpContent>
    
    参数
    
    allocator - ByteBufAllocator如果缓冲区分配是必要的。
    
    结果
    
    获取的块。 null如果流中没有剩余数据。请注意， null并不一定意味着该流已到达结尾。在缓慢的流中，下一个块可能暂时不可用。
    
    异常
    
    java.lang.Exception
  - length
```
public long length()
```
    从界面复制的描述： ChunkedInput
    
    返回输入的长度。
    
    Specified by:
    
    length在界面 ChunkedInput<HttpContent>
    
    结果
    
    如果输入的长度已知，则输入的长度。如果输入的长度未知，则为负值。
  - progress
```
public long progress()
```
    从接口ChunkedInput复制的描述
    
    返回当前传输进度。
    
    Specified by:
    
    progress在界面 ChunkedInput<HttpContent>

Class HttpChunkedInput

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

构造方法详细信息

HttpChunkedInput

HttpChunkedInput

方法详细信息

isEndOfInput

close

readChunk

readChunk

length

progress