Class WebSocketChunkedInput

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>

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

Modifier and Type	Field	Description
private final ChunkedInput<ByteBuf>	input
private final int	rsv

Constructor Summary

Constructors

Constructor	Description
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.

Method Summary

Modifier and Type	Method	Description
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)	Deprecated. Use readChunk(ByteBufAllocator).

Methods inherited from class java.lang.Object

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

Field Details

input

private final ChunkedInput<ByteBuf> input

rsv

private final int rsv

Constructor Details

WebSocketChunkedInput

public WebSocketChunkedInput(ChunkedInput<ByteBuf> input)

Creates a new instance using the specified input.

Parameters:

input - ChunkedInput containing data to write

WebSocketChunkedInput

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

Creates a new instance using the specified input.

Parameters:

input - ChunkedInput containing data to write

rsv - RSV1, RSV2, RSV3 used for extensions

Throws:

java.lang.NullPointerException - if input is null

Method Details

isEndOfInput

public boolean isEndOfInput()
                     throws java.lang.Exception

Description copied from interface: ChunkedInput

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

Specified by:

isEndOfInput in interface ChunkedInput<WebSocketFrame>

Returns:

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

Throws:

java.lang.Exception

close

public void close()
           throws java.lang.Exception

Releases the resources associated with the input.

Specified by:

close in interface ChunkedInput<WebSocketFrame>

Throws:

java.lang.Exception

readChunk

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

Deprecated.

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.

Specified by:

readChunk in interface ChunkedInput<WebSocketFrame>

Parameters:

ctx - ChannelHandlerContext context of channelHandler

Returns:

WebSocketFrame contain chunk of data

Throws:

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.

Specified by:

readChunk in interface ChunkedInput<WebSocketFrame>

Parameters:

allocator - ByteBufAllocator

Returns:

WebSocketFrame contain chunk of data

Throws:

java.lang.Exception

length

public long length()

Description copied from interface: ChunkedInput

Returns the length of the input.

Specified by:

length in interface ChunkedInput<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 interface ChunkedInput<WebSocketFrame>