io.netty.handler.codec.http.websocketx

类 CloseWebSocketFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

io.netty.handler.codec.http.websocketx.WebSocketFrame

io.netty.handler.codec.http.websocketx.CloseWebSocketFrame

所有已实现的接口:

ByteBufHolder, ReferenceCounted

public class CloseWebSocketFrame
extends WebSocketFrame

Web Socket Frame for closing the connection.

构造器概要

构造器

构造器和说明
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, ByteBuf binaryData) Creates a new close frame
CloseWebSocketFrame(boolean finalFragment, int rsv, int statusCode, java.lang.String reasonText) Creates a new close frame with closing status code and reason text
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

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 io.netty.handler.codec.http.websocketx.WebSocketFrame

isFinalFragment, rsv, toString

从类继承的方法 io.netty.buffer.DefaultByteBufHolder

content, contentToString, equals, hashCode, refCnt, release, release

从类继承的方法 java.lang.Object

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

构造器详细资料

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

参数:

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

参数:

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

参数:

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

参数:

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

参数:

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

参数:

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.

方法详细资料

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()

从类复制的说明: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

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

指定者:

copy 在接口中 ByteBufHolder

覆盖:

copy 在类中 WebSocketFrame

duplicate

public CloseWebSocketFrame duplicate()

从类复制的说明: DefaultByteBufHolder

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

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

指定者:

duplicate 在接口中 ByteBufHolder

覆盖:

duplicate 在类中 WebSocketFrame

retainedDuplicate

public CloseWebSocketFrame retainedDuplicate()

从类复制的说明: DefaultByteBufHolder

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

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

指定者:

retainedDuplicate 在接口中 ByteBufHolder

覆盖:

retainedDuplicate 在类中 WebSocketFrame

另请参阅:

ByteBuf.retainedDuplicate()

replace

public CloseWebSocketFrame replace(ByteBuf content)

从类复制的说明: 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.

指定者:

replace 在接口中 ByteBufHolder

指定者:

replace 在类中 WebSocketFrame

retain

public CloseWebSocketFrame retain()

从接口复制的说明: ReferenceCounted

Increases the reference count by 1.

指定者:

retain 在接口中 ByteBufHolder

指定者:

retain 在接口中 ReferenceCounted

覆盖:

retain 在类中 WebSocketFrame

retain

public CloseWebSocketFrame retain(int increment)

从接口复制的说明: ReferenceCounted

Increases the reference count by the specified increment.

指定者:

retain 在接口中 ByteBufHolder

指定者:

retain 在接口中 ReferenceCounted

覆盖:

retain 在类中 WebSocketFrame

touch

public CloseWebSocketFrame touch()

从接口复制的说明: 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).

指定者:

touch 在接口中 ByteBufHolder

指定者:

touch 在接口中 ReferenceCounted

覆盖:

touch 在类中 WebSocketFrame

touch

public CloseWebSocketFrame touch(java.lang.Object hint)

从接口复制的说明: 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.

指定者:

touch 在接口中 ByteBufHolder

指定者:

touch 在接口中 ReferenceCounted

覆盖:

touch 在类中 WebSocketFrame