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
Web Socket text frame.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates 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, 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
(String text) Creates a new text frame with the specified text string. -
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a deep copy of thisByteBufHolder
.Duplicates thisByteBufHolder
.private static ByteBuf
Returns a newByteBufHolder
which contains the specifiedcontent
.retain()
Increases the reference count by1
.retain
(int increment) Increases the reference count by the specifiedincrement
.Duplicates thisByteBufHolder
.text()
Returns the text data in this frame.touch()
Records the current access location of this object for debugging purposes.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
-
Constructor Details
-
TextWebSocketFrame
public TextWebSocketFrame()Creates a new empty text frame. -
TextWebSocketFrame
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
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
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 fragmentrsv
- reserved bits used for protocol extensionstext
- String to put in the frame.
-
TextWebSocketFrame
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 fragmentrsv
- reserved bits used for protocol extensionsbinaryData
- the content of the frame.
-
-
Method Details
-
fromText
-
text
Returns the text data in this frame. -
copy
Description copied from class:DefaultByteBufHolder
Creates a deep copy of thisByteBufHolder
.This method calls
replace(content().copy())
by default.- Specified by:
copy
in interfaceByteBufHolder
- Overrides:
copy
in classWebSocketFrame
-
duplicate
Description copied from class:DefaultByteBufHolder
Duplicates thisByteBufHolder
. Be aware that this will not automatically callByteBufHolder.retain()
.This method calls
replace(content().duplicate())
by default.- Specified by:
duplicate
in interfaceByteBufHolder
- Overrides:
duplicate
in classWebSocketFrame
-
retainedDuplicate
Description copied from class:DefaultByteBufHolder
Duplicates thisByteBufHolder
. This method returns a retained duplicate unlikeByteBufHolder.duplicate()
.This method calls
replace(content().retainedDuplicate())
by default.- Specified by:
retainedDuplicate
in interfaceByteBufHolder
- Overrides:
retainedDuplicate
in classWebSocketFrame
- See Also:
-
replace
Description copied from class:DefaultByteBufHolder
Returns a newByteBufHolder
which contains the specifiedcontent
.Override this method to return a new instance of this object whose content is set to the specified
content
. The default implementation ofDefaultByteBufHolder.copy()
,DefaultByteBufHolder.duplicate()
andDefaultByteBufHolder.retainedDuplicate()
invokes this method to create a copy.- Specified by:
replace
in interfaceByteBufHolder
- Specified by:
replace
in classWebSocketFrame
-
retain
Description copied from interface:ReferenceCounted
Increases the reference count by1
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceReferenceCounted
- Overrides:
retain
in classWebSocketFrame
-
retain
Description copied from interface:ReferenceCounted
Increases the reference count by the specifiedincrement
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceReferenceCounted
- Overrides:
retain
in classWebSocketFrame
-
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 viaResourceLeakDetector
. This method is a shortcut totouch(null)
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceReferenceCounted
- Overrides:
touch
in classWebSocketFrame
-
touch
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 viaResourceLeakDetector
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceReferenceCounted
- Overrides:
touch
in classWebSocketFrame
-