Class WebSocketFrame
- java.lang.Object
-
- io.netty.buffer.DefaultByteBufHolder
-
- io.netty.handler.codec.http.websocketx.WebSocketFrame
-
- All Implemented Interfaces:
ByteBufHolder
,ReferenceCounted
- Direct Known Subclasses:
BinaryWebSocketFrame
,CloseWebSocketFrame
,ContinuationWebSocketFrame
,PingWebSocketFrame
,PongWebSocketFrame
,TextWebSocketFrame
public abstract class WebSocketFrame extends DefaultByteBufHolder
Base class for web socket frames.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
WebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)
protected
WebSocketFrame(ByteBuf binaryData)
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description WebSocketFrame
copy()
Creates a deep copy of thisByteBufHolder
.WebSocketFrame
duplicate()
Duplicates thisByteBufHolder
.boolean
isFinalFragment()
Flag to indicate if this frame is the final fragment in a message.abstract WebSocketFrame
replace(ByteBuf content)
Returns a newByteBufHolder
which contains the specifiedcontent
.WebSocketFrame
retain()
Increases the reference count by1
.WebSocketFrame
retain(int increment)
Increases the reference count by the specifiedincrement
.WebSocketFrame
retainedDuplicate()
Duplicates thisByteBufHolder
.int
rsv()
Bits used for extensions to the standard.java.lang.String
toString()
WebSocketFrame
touch()
Records the current access location of this object for debugging purposes.WebSocketFrame
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.buffer.DefaultByteBufHolder
content, contentToString, equals, hashCode, refCnt, release, release
-
-
-
-
Method Detail
-
isFinalFragment
public boolean isFinalFragment()
Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the final fragment.
-
rsv
public int rsv()
Bits used for extensions to the standard.
-
copy
public WebSocketFrame 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 classDefaultByteBufHolder
-
duplicate
public WebSocketFrame 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 classDefaultByteBufHolder
-
retainedDuplicate
public WebSocketFrame 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 classDefaultByteBufHolder
- See Also:
ByteBuf.retainedDuplicate()
-
replace
public abstract WebSocketFrame 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
- Overrides:
replace
in classDefaultByteBufHolder
-
toString
public java.lang.String toString()
- Overrides:
toString
in classDefaultByteBufHolder
-
retain
public WebSocketFrame retain()
Description copied from interface:ReferenceCounted
Increases the reference count by1
.- Specified by:
retain
in interfaceByteBufHolder
- Specified by:
retain
in interfaceReferenceCounted
- Overrides:
retain
in classDefaultByteBufHolder
-
retain
public WebSocketFrame 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 classDefaultByteBufHolder
-
touch
public WebSocketFrame 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 classDefaultByteBufHolder
-
touch
public WebSocketFrame 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 classDefaultByteBufHolder
-
-