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 getStatus 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 getStatus code and reason text

方法概要

方法

限定符和类型	方法和说明
CloseWebSocketFrame	copy() Create a deep copy of this ByteBufHolder.
CloseWebSocketFrame	duplicate() Duplicate the 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	retain() Increases the reference count by 1.
CloseWebSocketFrame	retain(int increment) Increases the reference count by the specified increment.
int	statusCode() Returns the closing status code as per RFC 6455.

从类继承的方法 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(int statusCode,
                   java.lang.String reasonText)

Creates a new empty close frame with closing getStatus 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 getStatus 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 getStatus 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()

从接口复制的说明: ByteBufHolder

Create a deep copy of this ByteBufHolder.

指定者:

copy 在接口中 ByteBufHolder

指定者:

copy 在类中 WebSocketFrame

duplicate

public CloseWebSocketFrame duplicate()

从接口复制的说明: ByteBufHolder

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

指定者:

duplicate 在接口中 ByteBufHolder

指定者:

duplicate 在类中 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