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:

io.netty.buffer.ByteBufHolder, io.netty.util.ReferenceCounted

public class TextWebSocketFrame
extends WebSocketFrame

Web Socket text frame.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TextWebSocketFrame	copy()
TextWebSocketFrame	duplicate()
TextWebSocketFrame	replace(io.netty.buffer.ByteBuf content)
TextWebSocketFrame	retain()
TextWebSocketFrame	retain(int increment)
TextWebSocketFrame	retainedDuplicate()
String	text() Returns the text data in this frame.
TextWebSocketFrame	touch()
TextWebSocketFrame	touch(Object hint)

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(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(io.netty.buffer.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,
                          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,
                          io.netty.buffer.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 String text()

Returns the text data in this frame.

copy

public TextWebSocketFrame copy()

Specified by:

copy in interface io.netty.buffer.ByteBufHolder

Overrides:

copy in class WebSocketFrame

duplicate

public TextWebSocketFrame duplicate()

Specified by:

duplicate in interface io.netty.buffer.ByteBufHolder

Overrides:

duplicate in class WebSocketFrame

retainedDuplicate

public TextWebSocketFrame retainedDuplicate()

Specified by:

retainedDuplicate in interface io.netty.buffer.ByteBufHolder

Overrides:

retainedDuplicate in class WebSocketFrame

replace

public TextWebSocketFrame replace(io.netty.buffer.ByteBuf content)

Specified by:

replace in interface io.netty.buffer.ByteBufHolder

Specified by:

replace in class WebSocketFrame

retain

public TextWebSocketFrame retain()

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.util.ReferenceCounted

Overrides:

retain in class WebSocketFrame

retain

public TextWebSocketFrame retain(int increment)

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.util.ReferenceCounted

Overrides:

retain in class WebSocketFrame

touch

public TextWebSocketFrame touch()

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface io.netty.util.ReferenceCounted

Overrides:

touch in class WebSocketFrame

touch

public TextWebSocketFrame touch(Object hint)

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface io.netty.util.ReferenceCounted

Overrides:

touch in class WebSocketFrame