Class CloseWebSocketFrame
java.lang.Object
io.netty.buffer.DefaultByteBufHolder
io.netty.handler.codec.http.websocketx.WebSocketFrame
io.netty.handler.codec.http.websocketx.CloseWebSocketFrame
- All Implemented Interfaces:
ByteBufHolder
,ReferenceCounted
Web Socket Frame for closing the connection.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates a new empty close frame.CloseWebSocketFrame
(boolean finalFragment, int rsv) Creates a new close frame with no losing status code and no reason textCloseWebSocketFrame
(boolean finalFragment, int rsv, int statusCode, String reasonText) Creates a new close frame with closing status code and reason textCloseWebSocketFrame
(boolean finalFragment, int rsv, ByteBuf binaryData) Creates a new close frameCloseWebSocketFrame
(int statusCode, String reasonText) Creates a new empty close frame with closing status code and reason textCreates a new empty close frame with closing status code and reason textCloseWebSocketFrame
(WebSocketCloseStatus status, String reasonText) Creates a new empty close frame with closing status code and reason text -
Method Summary
Modifier and TypeMethodDescriptioncopy()
Creates a deep copy of thisByteBufHolder
.Duplicates thisByteBufHolder
.private static ByteBuf
newBinaryData
(int statusCode, String reasonText) Returns the reason text as per RFC 6455 If a reason text is not supplied, an empty string is returned.Returns a newByteBufHolder
which contains the specifiedcontent
.(package private) static int
requireValidStatusCode
(int statusCode) retain()
Increases the reference count by1
.retain
(int increment) Increases the reference count by the specifiedincrement
.Duplicates thisByteBufHolder
.int
Returns the closing status code as per RFC 6455.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
-
CloseWebSocketFrame
public CloseWebSocketFrame()Creates a new empty close frame. -
CloseWebSocketFrame
Creates a new empty close frame with closing status code and reason text- Parameters:
status
- Status code as per RFC 6455. For example, 1000 indicates normal closure.
-
CloseWebSocketFrame
Creates a new empty close frame with closing status code and reason text- Parameters:
status
- Status code as per RFC 6455. For example, 1000 indicates normal closure.reasonText
- Reason text. Set to null if no text.
-
CloseWebSocketFrame
Creates a new empty close frame with closing status code and reason text- Parameters:
statusCode
- Integer status code as per RFC 6455. For example, 1000 indicates normal closure.reasonText
- Reason text. Set to null if no text.
-
CloseWebSocketFrame
public CloseWebSocketFrame(boolean finalFragment, int rsv) Creates a new close frame with no losing status code and no reason text- Parameters:
finalFragment
- flag indicating if this frame is the final fragmentrsv
- reserved bits used for protocol extensions.
-
CloseWebSocketFrame
Creates a new close frame with closing status code and reason text- Parameters:
finalFragment
- flag indicating if this frame is the final fragmentrsv
- reserved bits used for protocol extensionsstatusCode
- Integer status code as per RFC 6455. For example, 1000 indicates normal closure.reasonText
- Reason text. Set to null if no text.
-
CloseWebSocketFrame
Creates a new close frame- Parameters:
finalFragment
- flag indicating if this frame is the final fragmentrsv
- reserved bits used for protocol extensionsbinaryData
- the content of the frame. Must be 2 byte integer followed by optional UTF-8 encoded string.
-
-
Method Details
-
newBinaryData
-
statusCode
public int statusCode()Returns the closing status code as per RFC 6455. If a status code is set, -1 is returned. -
reasonText
Returns the reason text as per RFC 6455 If a reason text is not supplied, an empty string is returned. -
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
-
requireValidStatusCode
static int requireValidStatusCode(int statusCode)
-