Class ContinuationWebSocketFrame
- java.lang.Object
-
- io.netty.buffer.DefaultByteBufHolder
-
- io.netty.handler.codec.http.websocketx.WebSocketFrame
-
- io.netty.handler.codec.http.websocketx.ContinuationWebSocketFrame
-
- All Implemented Interfaces:
ByteBufHolder
,ReferenceCounted
public class ContinuationWebSocketFrame extends WebSocketFrame
Web Socket continuation frame containing continuation text or binary data. This is used for fragmented messages where the contents of a messages is contained more than 1 frame.
-
-
Constructor Summary
Constructors Constructor Description ContinuationWebSocketFrame()
Creates a new empty continuation frame.ContinuationWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)
Creates a new continuation frame with the specified binary data.ContinuationWebSocketFrame(boolean finalFragment, int rsv, java.lang.String text)
Creates a new continuation frame with the specified text dataContinuationWebSocketFrame(ByteBuf binaryData)
Creates a new continuation frame with the specified binary data.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ContinuationWebSocketFrame
copy()
Creates a deep copy of thisByteBufHolder
.ContinuationWebSocketFrame
duplicate()
Duplicates thisByteBufHolder
.ContinuationWebSocketFrame
replace(ByteBuf content)
Returns a newByteBufHolder
which contains the specifiedcontent
.ContinuationWebSocketFrame
retain()
Increases the reference count by1
.ContinuationWebSocketFrame
retain(int increment)
Increases the reference count by the specifiedincrement
.ContinuationWebSocketFrame
retainedDuplicate()
Duplicates thisByteBufHolder
.java.lang.String
text()
Returns the text data in this frame.ContinuationWebSocketFrame
touch()
Records the current access location of this object for debugging purposes.ContinuationWebSocketFrame
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
-
-
-
-
Constructor Detail
-
ContinuationWebSocketFrame
public ContinuationWebSocketFrame()
Creates a new empty continuation frame.
-
ContinuationWebSocketFrame
public ContinuationWebSocketFrame(ByteBuf binaryData)
Creates a new continuation frame with the specified binary data. The final fragment flag is set to true.- Parameters:
binaryData
- the content of the frame.
-
ContinuationWebSocketFrame
public ContinuationWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)
Creates a new continuation frame with the specified binary data.- Parameters:
finalFragment
- flag indicating if this frame is the final fragmentrsv
- reserved bits used for protocol extensionsbinaryData
- the content of the frame.
-
ContinuationWebSocketFrame
public ContinuationWebSocketFrame(boolean finalFragment, int rsv, java.lang.String text)
Creates a new continuation frame with the specified text data- Parameters:
finalFragment
- flag indicating if this frame is the final fragmentrsv
- reserved bits used for protocol extensionstext
- text content of the frame.
-
-
Method Detail
-
text
public java.lang.String text()
Returns the text data in this frame.
-
copy
public ContinuationWebSocketFrame 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
public ContinuationWebSocketFrame 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
public ContinuationWebSocketFrame 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:
ByteBuf.retainedDuplicate()
-
replace
public ContinuationWebSocketFrame replace(ByteBuf content)
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
public ContinuationWebSocketFrame 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
public ContinuationWebSocketFrame retain(int increment)
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
public ContinuationWebSocketFrame 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
public ContinuationWebSocketFrame 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 viaResourceLeakDetector
.- Specified by:
touch
in interfaceByteBufHolder
- Specified by:
touch
in interfaceReferenceCounted
- Overrides:
touch
in classWebSocketFrame
-
-