io.netty.handler.codec.http.websocketx

类 TextWebSocketFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

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

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

所有已实现的接口:

ByteBufHolder, ReferenceCounted

public class TextWebSocketFrame
extends WebSocketFrame

Web Socket text frame.

构造器概要

构造器

构造器和说明
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.

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 io.netty.handler.codec.http.websocketx.WebSocketFrame

isFinalFragment, rsv, toString

从类继承的方法 io.netty.buffer.DefaultByteBufHolder

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

从类继承的方法 java.lang.Object

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

构造器详细资料

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.

参数:

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.

参数:

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.

参数:

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.

参数:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

binaryData - the content of the frame.

方法详细资料

text

public java.lang.String text()

Returns the text data in this frame.

copy

public TextWebSocketFrame copy()

从类复制的说明: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

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

指定者:

copy 在接口中 ByteBufHolder

覆盖:

copy 在类中 WebSocketFrame

duplicate

public TextWebSocketFrame duplicate()

从类复制的说明: DefaultByteBufHolder

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

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

指定者:

duplicate 在接口中 ByteBufHolder

覆盖:

duplicate 在类中 WebSocketFrame

retainedDuplicate

public TextWebSocketFrame retainedDuplicate()

从类复制的说明: DefaultByteBufHolder

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

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

指定者:

retainedDuplicate 在接口中 ByteBufHolder

覆盖:

retainedDuplicate 在类中 WebSocketFrame

另请参阅:

ByteBuf.retainedDuplicate()

replace

public TextWebSocketFrame replace(ByteBuf content)

从类复制的说明: 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.

指定者:

replace 在接口中 ByteBufHolder

指定者:

replace 在类中 WebSocketFrame

retain

public TextWebSocketFrame retain()

从接口复制的说明: ReferenceCounted

Increases the reference count by 1.

指定者:

retain 在接口中 ByteBufHolder

指定者:

retain 在接口中 ReferenceCounted

覆盖:

retain 在类中 WebSocketFrame

retain

public TextWebSocketFrame retain(int increment)

从接口复制的说明: ReferenceCounted

Increases the reference count by the specified increment.

指定者:

retain 在接口中 ByteBufHolder

指定者:

retain 在接口中 ReferenceCounted

覆盖:

retain 在类中 WebSocketFrame

touch

public TextWebSocketFrame touch()

从接口复制的说明: 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).

指定者:

touch 在接口中 ByteBufHolder

指定者:

touch 在接口中 ReferenceCounted

覆盖:

touch 在类中 WebSocketFrame

touch

public TextWebSocketFrame touch(java.lang.Object hint)

从接口复制的说明: 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.

指定者:

touch 在接口中 ByteBufHolder

指定者:

touch 在接口中 ReferenceCounted

覆盖:

touch 在类中 WebSocketFrame