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 with assumed UTF-8 encoding

Constructor Summary

Constructors

Constructor and 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.
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 and Description
TextWebSocketFrame	copy() Create a deep copy of this ByteBufHolder.
TextWebSocketFrame	duplicate() Duplicate the ByteBufHolder.
TextWebSocketFrame	retain() Increases the reference count by 1.
TextWebSocketFrame	retain(int increment) Increases the reference count by the specified increment.
java.lang.String	text() Returns the text data in this frame

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. Must be UTF-8 encoded

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

binaryData - the content of the frame. Must be UTF-8 encoded

Method Detail

text

public java.lang.String text()

Returns the text data in this frame

copy

public TextWebSocketFrame copy()

Description copied from interface: ByteBufHolder

Create a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in class WebSocketFrame

duplicate

public TextWebSocketFrame duplicate()

Description copied from interface: ByteBufHolder

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

Specified by:

duplicate in interface ByteBufHolder

Specified by:

duplicate 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