WebSocketChunkedInput (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.handler.codec.http.websocketx.WebSocketChunkedInput

All Implemented Interfaces:

ChunkedInput < WebSocketFrame >
```
public final class WebSocketChunkedInput
extends java.lang.Object
implements ChunkedInput<WebSocketFrame>
```
一个ChunkedInput ，通过块获取数据块以用于WebSocket分块传输。
来自输入数据的每个块将被包装在ContinuationWebSocketFrame内。在输入数据的末尾，将会写入带有finalFragment的ContinuationWebSocketFrame。

构造方法摘要

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

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`void`	`close()` 释放与输入相关的资源。
`boolean`	`isEndOfInput()` 返回 `true`当且仅当数据流中没有剩余数据且数据流已达到其结尾时。
`long`	`length()` 返回输入的长度。
`long`	`progress()` 返回当前传输进度。
`WebSocketFrame`	`readChunk(ByteBufAllocator allocator)` 从流中获取分块的数据。
`WebSocketFrame`	`readChunk(ChannelHandlerContext ctx)` 已过时。使用`readChunk(ByteBufAllocator)` 。从流中获取分块的数据。一旦此方法返回最后一个块并因此流到达末尾，任何后续的`isEndOfInput()`调用都必须返回`true` 。

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

- 构造方法详细信息
  - WebSocketChunkedInput
```
public WebSocketChunkedInput(ChunkedInput<ByteBuf> input)
```
    使用指定的输入创建一个新实例。
    
    参数
    
    input - ChunkedInput包含要写入的数据
  - WebSocketChunkedInput
```
public WebSocketChunkedInput(ChunkedInput<ByteBuf> input,
                             int rsv)
```
    使用指定的输入创建一个新实例。
    
    参数
    
    input - ChunkedInput包含要写入的数据
    
    rsv - 用于扩展的RSV1，RSV2，RSV3
    
    异常
    
    java.lang.NullPointerException - 如果 input为空
- 方法详细信息
  - isEndOfInput
```
public boolean isEndOfInput()
                     throws java.lang.Exception
```
    从界面复制的描述： ChunkedInput
    
    返回 true当且仅当数据流中没有剩余数据且数据流已达到其结尾时。
    
    Specified by:
    
    isEndOfInput接口 ChunkedInput<WebSocketFrame>
    
    结果
    
    true当且仅当数据流中没有剩余数据且数据流已达到数据结束时。
    
    异常
    
    java.lang.Exception
  - close
```
public void close()
           throws java.lang.Exception
```
    释放与输入相关的资源。
    
    Specified by:
    
    close接口 ChunkedInput<WebSocketFrame>
    
    异常
    
    java.lang.Exception
  - readChunk
```
@Deprecated
public WebSocketFrame readChunk(ChannelHandlerContext ctx)
                                     throws java.lang.Exception
```
    已过时。使用readChunk(ByteBufAllocator) 。从流中获取分块的数据。一旦此方法返回最后一个块并因此流到达末尾，任何后续的isEndOfInput()调用都必须返回true 。
    
    Specified by:
    
    readChunk在界面 ChunkedInput<WebSocketFrame>
    
    参数
    
    ctx - ChannelHandlerContext channelHandler的上下文
    
    结果
    
    WebSocketFrame包含大量的数据
    
    异常
    
    java.lang.Exception
  - readChunk
```
public WebSocketFrame readChunk(ByteBufAllocator allocator)
                         throws java.lang.Exception
```
    从流中获取分块的数据。一旦此方法返回最后一个块并因此流到达末尾，任何后续isEndOfInput()调用都必须返回true 。
    
    Specified by:
    
    readChunk在界面 ChunkedInput<WebSocketFrame>
    
    参数
    
    allocator - ByteBufAllocator
    
    结果
    
    WebSocketFrame包含大量的数据
    
    异常
    
    java.lang.Exception
  - length
```
public long length()
```
    从界面复制的描述： ChunkedInput
    
    返回输入的长度。
    
    Specified by:
    
    length接口 ChunkedInput<WebSocketFrame>
    
    结果
    
    如果输入的长度已知，则输入的长度。如果输入的长度未知，则为负值。
  - progress
```
public long progress()
```
    从接口复制的描述： ChunkedInput
    
    返回当前传输进度。
    
    Specified by:
    
    progress在界面 ChunkedInput<WebSocketFrame>

Class WebSocketChunkedInput

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

构造方法详细信息

WebSocketChunkedInput

WebSocketChunkedInput

方法详细信息

isEndOfInput

close

readChunk

readChunk

length

progress