Class WebSocketChunkedInput
java.lang.Object
io.netty.handler.codec.http.websocketx.WebSocketChunkedInput
- All Implemented Interfaces:
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.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionWebSocketChunkedInput
(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. -
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
-
rsv
private final int rsv
-
-
Constructor Details
-
WebSocketChunkedInput
Creates a new instance using the specified input.- Parameters:
input
-ChunkedInput
containing data to write
-
WebSocketChunkedInput
Creates a new instance using the specified input.- Parameters:
input
-ChunkedInput
containing data to writersv
- RSV1, RSV2, RSV3 used for extensions- Throws:
NullPointerException
- ifinput
is null
-
-
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<WebSocketFrame>
- Returns:
true
if and only if there is no data left in the stream and the stream has reached at its end.- Throws:
Exception
-
close
Releases the resources associated with the input.- Specified by:
close
in interfaceChunkedInput<WebSocketFrame>
- Throws:
Exception
-
readChunk
Deprecated.UsereadChunk(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 subsequentisEndOfInput()
call must returntrue
.- Specified by:
readChunk
in interfaceChunkedInput<WebSocketFrame>
- Parameters:
ctx
-ChannelHandlerContext
context of channelHandler- Returns:
WebSocketFrame
contain chunk of data- Throws:
Exception
-
readChunk
Fetches a chunked data from the stream. Once this method returns the last chunk and thus the stream has reached at its end, any subsequentisEndOfInput()
call must returntrue
.- Specified by:
readChunk
in interfaceChunkedInput<WebSocketFrame>
- Parameters:
allocator
-ByteBufAllocator
- Returns:
WebSocketFrame
contain chunk of data- Throws:
Exception
-
length
public long length()Description copied from interface:ChunkedInput
Returns the length of the input.- Specified by:
length
in interfaceChunkedInput<WebSocketFrame>
- 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<WebSocketFrame>
-
readChunk(ByteBufAllocator)
.