Package io.netty.handler.codec.http.websocketx

Class TextWebSocketFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

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

io.netty.handler.codec.http.websocketx.TextWebSocketFrame

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted

public class TextWebSocketFrame
extends WebSocketFrame

Web Socket text frame.

Constructor Summary

Constructors

Constructor	Description
TextWebSocketFrame()	Creates a new empty text frame.
TextWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)	Creates a new text frame with the specified binary data and the final fragment flag.
TextWebSocketFrame(boolean finalFragment, int rsv, java.lang.String text)	Creates a new text frame with the specified text string.
TextWebSocketFrame(ByteBuf binaryData)	Creates a new text frame with the specified binary data.
TextWebSocketFrame(java.lang.String text)	Creates a new text frame with the specified text string.

Method Summary

Modifier and Type	Method	Description
TextWebSocketFrame	copy()	Creates a deep copy of this ByteBufHolder.
TextWebSocketFrame	duplicate()	Duplicates this ByteBufHolder.
TextWebSocketFrame	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
TextWebSocketFrame	retain()	Increases the reference count by 1.
TextWebSocketFrame	retain(int increment)	Increases the reference count by the specified increment.
TextWebSocketFrame	retainedDuplicate()	Duplicates this ByteBufHolder.
java.lang.String	text()	Returns the text data in this frame.
TextWebSocketFrame	touch()	Records the current access location of this object for debugging purposes.
TextWebSocketFrame	touch(java.lang.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

TextWebSocketFrame

public TextWebSocketFrame()

Creates a new empty text frame.

TextWebSocketFrame

public TextWebSocketFrame(java.lang.String text)

Creates a new text frame with the specified text string. The final fragment flag is set to true.

Parameters:

text - String to put in the frame.

TextWebSocketFrame

public TextWebSocketFrame(ByteBuf binaryData)

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

Parameters:

binaryData - the content of the frame.

TextWebSocketFrame

public TextWebSocketFrame(boolean finalFragment,
                          int rsv,
                          java.lang.String text)

Creates a new text frame with the specified text string. The final fragment flag is set to true.

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

text - String to put in the frame.

TextWebSocketFrame

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

Creates a new text frame with the specified binary data and the final fragment flag.

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

binaryData - the content of the frame.

Method Detail

text

public java.lang.String text()

Returns the text data in this frame.

copy

public TextWebSocketFrame 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 TextWebSocketFrame 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 TextWebSocketFrame 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 TextWebSocketFrame 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 TextWebSocketFrame 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 TextWebSocketFrame 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 TextWebSocketFrame 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 TextWebSocketFrame touch(java.lang.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