Top Description Constructors Methods
io.netty.handler.codec.http.websocketx

public Class ContinuationWebSocketFrame

extends WebSocketFrame
Class Inheritance
Imports
io.netty.buffer.ByteBuf, .Unpooled, io.netty.util.CharsetUtil
Web Socket continuation frame containing continuation text or binary data. This is used for fragmented messages where the contents of a messages is contained more than 1 frame.

Constructor Summary

AccessConstructor and Description
public
ContinuationWebSocketFrame()

Creates a new empty continuation frame.

public
ContinuationWebSocketFrame(ByteBuf
the content of the frame.
binaryData)

Creates a new continuation frame with the specified binary data.

public
ContinuationWebSocketFrame(boolean
flag indicating if this frame is the final fragment
finalFragment, int
reserved bits used for protocol extensions
rsv, ByteBuf
the content of the frame.
binaryData)

Creates a new continuation frame with the specified binary data.

public
ContinuationWebSocketFrame(boolean
flag indicating if this frame is the final fragment
finalFragment, int
reserved bits used for protocol extensions
rsv, String
text content of the frame.
text)

Creates a new continuation frame with the specified text data

Method Summary

Modifier and TypeMethod and Description
public ContinuationWebSocketFrame
copy()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.copy.

Implements io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.
public ContinuationWebSocketFrame
duplicate()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.duplicate.

Implements io.netty.buffer.ByteBufHolder.duplicate.

Duplicates this ByteBufHolder.
private static ByteBuf
fromText(String
text to store.
text)

Sets the string for this frame.

public ContinuationWebSocketFrame
replace(ByteBuf content)

Implements abstract io.netty.handler.codec.http.websocketx.WebSocketFrame.replace.

Implements io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.
public ContinuationWebSocketFrame
retain()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.retain.

Implements io.netty.buffer.ByteBufHolder.retain.

Increases the reference count by 1.
public ContinuationWebSocketFrame
retain(int increment)

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.retain.

Implements io.netty.buffer.ByteBufHolder.retain.

Increases the reference count by the specified increment.
public ContinuationWebSocketFrame
retainedDuplicate()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.retainedDuplicate.

Implements io.netty.buffer.ByteBufHolder.retainedDuplicate.

Duplicates this ByteBufHolder.
public String
text()

Returns the text data in this frame.

public ContinuationWebSocketFrame
touch()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.touch.

Implements io.netty.buffer.ByteBufHolder.touch.

Records the current access location of this object for debugging purposes.
public ContinuationWebSocketFrame
touch(Object hint)

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.touch.

Implements io.netty.buffer.ByteBufHolder.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes.
Inherited from io.netty.handler.codec.http.websocketx.WebSocketFrame:
isFinalFragmentrsvtoString

Constructor Detail

ContinuationWebSocketFrameback to summary
public ContinuationWebSocketFrame()

Creates a new empty continuation frame.

ContinuationWebSocketFrameback to summary
public ContinuationWebSocketFrame(ByteBuf binaryData)

Creates a new continuation frame with the specified binary data. The final fragment flag is set to true.

Parameters
binaryData:ByteBuf

the content of the frame.

ContinuationWebSocketFrameback to summary
public ContinuationWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)

Creates a new continuation frame with the specified binary data.

Parameters
finalFragment:boolean

flag indicating if this frame is the final fragment

rsv:int

reserved bits used for protocol extensions

binaryData:ByteBuf

the content of the frame.

ContinuationWebSocketFrameback to summary
public ContinuationWebSocketFrame(boolean finalFragment, int rsv, String text)

Creates a new continuation frame with the specified text data

Parameters
finalFragment:boolean

flag indicating if this frame is the final fragment

rsv:int

reserved bits used for protocol extensions

text:String

text content of the frame.

Method Detail

copyback to summary
public ContinuationWebSocketFrame copy()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.copy.

Implements io.netty.buffer.ByteBufHolder.copy.

Doc from io.netty.buffer.DefaultByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

This method calls replace(content().copy()) by default.

Annotations
@Override
duplicateback to summary
public ContinuationWebSocketFrame duplicate()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.duplicate.

Implements io.netty.buffer.ByteBufHolder.duplicate.

Doc from io.netty.buffer.DefaultByteBufHolder.duplicate.

Duplicates this ByteBufHolder. Be aware that this will not automatically call retain().

This method calls replace(content().duplicate()) by default.

Annotations
@Override
fromTextback to summary
private static ByteBuf fromText(String text)

Sets the string for this frame.

Parameters
text:String

text to store.

replaceback to summary
public ContinuationWebSocketFrame replace(ByteBuf content)

Implements abstract io.netty.handler.codec.http.websocketx.WebSocketFrame.replace.

Implements io.netty.buffer.ByteBufHolder.replace.

Doc from io.netty.buffer.DefaultByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.

Override this method to return a new instance of this object whose content is set to the specified content. The default implementation of copy(), duplicate() and retainedDuplicate() invokes this method to create a copy.

Annotations
@Override
retainback to summary
public ContinuationWebSocketFrame retain()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.retain.

Implements io.netty.buffer.ByteBufHolder.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations
@Override
retainback to summary
public ContinuationWebSocketFrame retain(int increment)

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.retain.

Implements io.netty.buffer.ByteBufHolder.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations
@Override
retainedDuplicateback to summary
public ContinuationWebSocketFrame retainedDuplicate()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.retainedDuplicate.

Implements io.netty.buffer.ByteBufHolder.retainedDuplicate.

Doc from io.netty.buffer.DefaultByteBufHolder.retainedDuplicate.

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike duplicate().

This method calls replace(content().retainedDuplicate()) by default.

Annotations
@Override
textback to summary
public String text()

Returns the text data in this frame.

touchback to summary
public ContinuationWebSocketFrame touch()

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.touch.

Implements io.netty.buffer.ByteBufHolder.touch.

Doc from io.netty.util.ReferenceCounted.touch.

Records the current access location of this object for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector. This method is a shortcut to touch(null).

Annotations
@Override
touchback to summary
public ContinuationWebSocketFrame touch(Object hint)

Overrides io.netty.handler.codec.http.websocketx.WebSocketFrame.touch.

Implements io.netty.buffer.ByteBufHolder.touch.

Doc from io.netty.util.ReferenceCounted.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes. If this object is determined to be leaked, the information recorded by this operation will be provided to you via ResourceLeakDetector.

Annotations
@Override