Class BinaryWebSocketFrame
- java.lang.Object
-
- io.netty.buffer.DefaultByteBufHolder
-
- io.netty.handler.codec.http.websocketx.WebSocketFrame
-
- io.netty.handler.codec.http.websocketx.BinaryWebSocketFrame
-
- All Implemented Interfaces:
ByteBufHolder
,ReferenceCounted
public class BinaryWebSocketFrame extends WebSocketFrame
Web Socket frame containing binary data.
-
-
Constructor Summary
Constructors Constructor Description BinaryWebSocketFrame()
Creates a new empty binary frame.BinaryWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)
Creates a new binary frame with the specified binary data and the final fragment flag.BinaryWebSocketFrame(ByteBuf binaryData)
Creates a new binary frame with the specified binary data.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description BinaryWebSocketFrame
copy()
Creates a deep copy of thisByteBufHolder
.BinaryWebSocketFrame
duplicate()
Duplicates thisByteBufHolder
.BinaryWebSocketFrame
replace(ByteBuf content)
Returns a newByteBufHolder
which contains the specifiedcontent
.BinaryWebSocketFrame
retain()
Increases the reference count by1
.BinaryWebSocketFrame
retain(int increment)
Increases the reference count by the specifiedincrement
.BinaryWebSocketFrame
retainedDuplicate()
Duplicates thisByteBufHolder
.BinaryWebSocketFrame
touch()
Records the current access location of this object for debugging purposes.BinaryWebSocketFrame
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
-
BinaryWebSocketFrame
public BinaryWebSocketFrame()
Creates a new empty binary frame.
-
BinaryWebSocketFrame
public BinaryWebSocketFrame(ByteBuf binaryData)
Creates a new binary frame with the specified binary data. The final fragment flag is set to true.- Parameters:
binaryData
- the content of the frame.
-
BinaryWebSocketFrame
public BinaryWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)
Creates a new binary 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 Detail
-
copy
public BinaryWebSocketFrame 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 BinaryWebSocketFrame 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 BinaryWebSocketFrame 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 BinaryWebSocketFrame 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 BinaryWebSocketFrame 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 BinaryWebSocketFrame 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 BinaryWebSocketFrame 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 BinaryWebSocketFrame 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
-
-