io.netty.handler.codec.http.websocketx

类 WebSocketChunkedInput

java.lang.Object

io.netty.handler.codec.http.websocketx.WebSocketChunkedInput

所有已实现的接口:

ChunkedInput<WebSocketFrame>

public final class WebSocketChunkedInput
extends java.lang.Object
implements ChunkedInput<WebSocketFrame>

A ChunkedInput that fetches data chunk by chunk for use with WebSocket chunked transfers.

Each chunk from the input data will be wrapped within a ContinuationWebSocketFrame. At the end of the input data, ContinuationWebSocketFrame with finalFragment will be written.

构造器概要

构造器

构造器和说明
WebSocketChunkedInput(ChunkedInput<ByteBuf> input) Creates a new instance using the specified input.
WebSocketChunkedInput(ChunkedInput<ByteBuf> input, int rsv) 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.
WebSocketFrame	readChunk(ByteBufAllocator allocator) Fetches a chunked data from the stream.
WebSocketFrame	readChunk(ChannelHandlerContext ctx) 已过时。 Use readChunk(ByteBufAllocator). 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 isEndOfInput() call must return true.

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

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

构造器详细资料

WebSocketChunkedInput

public WebSocketChunkedInput(ChunkedInput<ByteBuf> input)

Creates a new instance using the specified input.

参数:

input - ChunkedInput containing data to write

WebSocketChunkedInput

public WebSocketChunkedInput(ChunkedInput<ByteBuf> input,
                             int rsv)

Creates a new instance using the specified input.

参数:

input - ChunkedInput containing data to write

rsv - RSV1, RSV2, RSV3 used for extensions

抛出:

java.lang.NullPointerException - if input is null

方法详细资料

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<WebSocketFrame>

返回:

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

抛出:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

Releases the resources associated with the input.

指定者:

close 在接口中 ChunkedInput<WebSocketFrame>

抛出:

java.lang.Exception

readChunk

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

已过时。 Use readChunk(ByteBufAllocator). 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 isEndOfInput() call must return true.

指定者:

readChunk 在接口中 ChunkedInput<WebSocketFrame>

参数:

ctx - ChannelHandlerContext context of channelHandler

返回:

WebSocketFrame contain chunk of data

抛出:

java.lang.Exception

readChunk

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

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 isEndOfInput() call must return true.

指定者:

readChunk 在接口中 ChunkedInput<WebSocketFrame>

参数:

allocator - ByteBufAllocator

返回:

WebSocketFrame contain chunk of data

抛出:

java.lang.Exception

length

public long length()

从接口复制的说明: ChunkedInput

Returns the length of the input.

指定者:

length 在接口中 ChunkedInput<WebSocketFrame>

返回:

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<WebSocketFrame>