Package io.netty.handler.codec.http.websocketx

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

public class CloseWebSocketFrame
extends WebSocketFrame

Web Socket Frame for closing the connection.

Constructor Summary

Constructors

Constructor	Description
CloseWebSocketFrame()	Creates a new empty close frame.
CloseWebSocketFrame(boolean finalFragment, int rsv)	Creates a new close frame with no losing status code and no reason text
CloseWebSocketFrame(boolean finalFragment, int rsv, int statusCode, java.lang.String reasonText)	Creates a new close frame with closing status code and reason text
CloseWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)	Creates a new close frame
CloseWebSocketFrame(int statusCode, java.lang.String reasonText)	Creates a new empty close frame with closing status code and reason text
CloseWebSocketFrame(WebSocketCloseStatus status)	Creates a new empty close frame with closing status code and reason text
CloseWebSocketFrame(WebSocketCloseStatus status, java.lang.String reasonText)	Creates a new empty close frame with closing status code and reason text

Method Summary

Modifier and Type	Method	Description
CloseWebSocketFrame	copy()	Creates a deep copy of this ByteBufHolder.
CloseWebSocketFrame	duplicate()	Duplicates this ByteBufHolder.
java.lang.String	reasonText()	Returns the reason text as per RFC 6455 If a reason text is not supplied, an empty string is returned.
CloseWebSocketFrame	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
CloseWebSocketFrame	retain()	Increases the reference count by 1.
CloseWebSocketFrame	retain(int increment)	Increases the reference count by the specified increment.
CloseWebSocketFrame	retainedDuplicate()	Duplicates this ByteBufHolder.
int	statusCode()	Returns the closing status code as per RFC 6455.
CloseWebSocketFrame	touch()	Records the current access location of this object for debugging purposes.
CloseWebSocketFrame	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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CloseWebSocketFrame

public CloseWebSocketFrame()

Creates a new empty close frame.

CloseWebSocketFrame

public CloseWebSocketFrame(WebSocketCloseStatus status)

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

public CloseWebSocketFrame(WebSocketCloseStatus status,
                           java.lang.String reasonText)

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

public CloseWebSocketFrame(int statusCode,
                           java.lang.String reasonText)

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 fragment

rsv - reserved bits used for protocol extensions.

CloseWebSocketFrame

public CloseWebSocketFrame(boolean finalFragment,
                           int rsv,
                           int statusCode,
                           java.lang.String reasonText)

Creates a new close frame with closing status code and reason text

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

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,
                           ByteBuf binaryData)

Creates a new close frame

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

binaryData - the content of the frame. Must be 2 byte integer followed by optional UTF-8 encoded string.

Method Detail

statusCode

public int statusCode()

Returns the closing status code as per RFC 6455. If a status code is set, -1 is returned.

reasonText

public java.lang.String reasonText()

Returns the reason text as per RFC 6455 If a reason text is not supplied, an empty string is returned.

copy

public CloseWebSocketFrame copy()

Description copied from class: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

This method calls replace(content().copy()) by default.

Specified by:

copy in interface ByteBufHolder

Overrides:

copy in class WebSocketFrame

duplicate

public CloseWebSocketFrame duplicate()

Description copied from class: DefaultByteBufHolder

Duplicates this ByteBufHolder. Be aware that this will not automatically call ByteBufHolder.retain().

This method calls replace(content().duplicate()) by default.

Specified by:

duplicate in interface ByteBufHolder

Overrides:

duplicate in class WebSocketFrame

retainedDuplicate

public CloseWebSocketFrame retainedDuplicate()

Description copied from class: DefaultByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

This method calls replace(content().retainedDuplicate()) by default.

Specified by:

retainedDuplicate in interface ByteBufHolder

Overrides:

retainedDuplicate in class WebSocketFrame

See Also:

ByteBuf.retainedDuplicate()

replace

public CloseWebSocketFrame replace(ByteBuf content)

Description copied from class: DefaultByteBufHolder

Returns a new ByteBufHolder which contains the specified content.

Override this method to return a new instance of this object whose content is set to the specified content. The default implementation of DefaultByteBufHolder.copy(), DefaultByteBufHolder.duplicate() and DefaultByteBufHolder.retainedDuplicate() invokes this method to create a copy.

Specified by:

replace in interface ByteBufHolder

Specified by:

replace in class WebSocketFrame

retain

public CloseWebSocketFrame retain()

Description copied from interface: ReferenceCounted

Increases the reference count by 1.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class WebSocketFrame

retain

public CloseWebSocketFrame retain(int increment)

Description copied from interface: ReferenceCounted

Increases the reference count by the specified increment.

Specified by:

retain in interface ByteBufHolder

Specified by:

retain in interface ReferenceCounted

Overrides:

retain in class WebSocketFrame

touch

public CloseWebSocketFrame 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 via ResourceLeakDetector. This method is a shortcut to touch(null).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class WebSocketFrame

touch

public CloseWebSocketFrame 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 via ResourceLeakDetector.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class WebSocketFrame