io.netty.handler.codec.http.websocketx

Class ContinuationWebSocketFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

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

io.netty.handler.codec.http.websocketx.ContinuationWebSocketFrame

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted

public class ContinuationWebSocketFrame
extends WebSocketFrame

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

Constructors

Constructor and Description
ContinuationWebSocketFrame() Creates a new empty continuation frame.
ContinuationWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) Creates a new continuation frame with the specified binary data.
ContinuationWebSocketFrame(boolean finalFragment, int rsv, String text) Creates a new continuation frame with the specified text data
ContinuationWebSocketFrame(ByteBuf binaryData) Creates a new continuation frame with the specified binary data.

Method Summary

Modifier and Type	Method and Description
ContinuationWebSocketFrame	copy() Creates a deep copy of this ByteBufHolder.
ContinuationWebSocketFrame	duplicate() Duplicates this ByteBufHolder.
ContinuationWebSocketFrame	replace(ByteBuf content) Returns a new ByteBufHolder which contains the specified content.
ContinuationWebSocketFrame	retain() Increases the reference count by 1.
ContinuationWebSocketFrame	retain(int increment) Increases the reference count by the specified increment.
ContinuationWebSocketFrame	retainedDuplicate() Duplicates this ByteBufHolder.
String	text() Returns the text data in this frame.
ContinuationWebSocketFrame	touch() Records the current access location of this object for debugging purposes.
ContinuationWebSocketFrame	touch(Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.

Methods inherited from class io.netty.handler.codec.http.websocketx.WebSocketFrame

isFinalFragment, rsv, toString

Methods inherited from class io.netty.buffer.DefaultByteBufHolder

content, contentToString, equals, hashCode, refCnt, release, release

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ContinuationWebSocketFrame

public ContinuationWebSocketFrame()

Creates a new empty continuation frame.

ContinuationWebSocketFrame

public ContinuationWebSocketFrame(ByteBuf binaryData)

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

Parameters:

binaryData - the content of the frame.

ContinuationWebSocketFrame

public ContinuationWebSocketFrame(boolean finalFragment,
                                  int rsv,
                                  ByteBuf binaryData)

Creates a new continuation frame with the specified binary data.

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

binaryData - the content of the frame.

ContinuationWebSocketFrame

public ContinuationWebSocketFrame(boolean finalFragment,
                                  int rsv,
                                  String text)

Creates a new continuation frame with the specified text data

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

text - text content of the frame.

Method Detail

text

public String text()

Returns the text data in this frame.

copy

public ContinuationWebSocketFrame copy()

Description copied from class: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

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

Specified by:

copy in interface ByteBufHolder

Overrides:

copy in class WebSocketFrame

duplicate

public ContinuationWebSocketFrame duplicate()

Description copied from class: DefaultByteBufHolder

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

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

Specified by:

duplicate in interface ByteBufHolder

Overrides:

duplicate in class WebSocketFrame

retainedDuplicate

public ContinuationWebSocketFrame retainedDuplicate()

Description copied from class: DefaultByteBufHolder

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

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

Specified by:

retainedDuplicate in interface ByteBufHolder

Overrides:

retainedDuplicate in class WebSocketFrame

See Also:

ByteBuf.retainedDuplicate()

replace

public ContinuationWebSocketFrame replace(ByteBuf content)

Description copied from class: DefaultByteBufHolder

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 DefaultByteBufHolder.copy(), DefaultByteBufHolder.duplicate() and DefaultByteBufHolder.retainedDuplicate() invokes this method to create a copy.

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in class WebSocketFrame

retain

public ContinuationWebSocketFrame retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class WebSocketFrame

retain

public ContinuationWebSocketFrame retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class WebSocketFrame

touch

public ContinuationWebSocketFrame touch()

Description copied from interface: ReferenceCounted

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).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class WebSocketFrame

touch

public ContinuationWebSocketFrame touch(Object hint)

Description copied from interface: ReferenceCounted

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.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class WebSocketFrame