io.netty.handler.codec.http.websocketx

类 WebSocketFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

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

所有已实现的接口:

ByteBufHolder, ReferenceCounted

直接已知子类:

BinaryWebSocketFrame, CloseWebSocketFrame, ContinuationWebSocketFrame, PingWebSocketFrame, PongWebSocketFrame, TextWebSocketFrame

public abstract class WebSocketFrame
extends DefaultByteBufHolder

Base class for web socket frames.

构造器概要

构造器

限定符	构造器和说明
protected	WebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)
protected	WebSocketFrame(ByteBuf binaryData)

方法概要

限定符和类型	方法和说明
WebSocketFrame	copy() Creates a deep copy of this ByteBufHolder.
WebSocketFrame	duplicate() Duplicates this ByteBufHolder.
boolean	isFinalFragment() Flag to indicate if this frame is the final fragment in a message.
abstract WebSocketFrame	replace(ByteBuf content) Returns a new ByteBufHolder which contains the specified content.
WebSocketFrame	retain() Increases the reference count by 1.
WebSocketFrame	retain(int increment) Increases the reference count by the specified increment.
WebSocketFrame	retainedDuplicate() Duplicates this ByteBufHolder.
int	rsv() Bits used for extensions to the standard.
java.lang.String	toString()
WebSocketFrame	touch() Records the current access location of this object for debugging purposes.
WebSocketFrame	touch(java.lang.Object hint) Records the current access location of this object with an additional arbitrary information for debugging purposes.

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

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

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

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

构造器详细资料

WebSocketFrame

protected WebSocketFrame(ByteBuf binaryData)

WebSocketFrame

protected WebSocketFrame(boolean finalFragment,
                         int rsv,
                         ByteBuf binaryData)

方法详细资料

isFinalFragment

public boolean isFinalFragment()

Flag to indicate if this frame is the final fragment in a message. The first fragment (frame) may also be the final fragment.

rsv

public int rsv()

Bits used for extensions to the standard.

copy

public WebSocketFrame copy()

从类复制的说明: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

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

指定者:

copy 在接口中 ByteBufHolder

覆盖:

copy 在类中 DefaultByteBufHolder

duplicate

public WebSocketFrame 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 在类中 DefaultByteBufHolder

retainedDuplicate

public WebSocketFrame 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 在类中 DefaultByteBufHolder

另请参阅:

ByteBuf.retainedDuplicate()

replace

public abstract WebSocketFrame 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 在类中 DefaultByteBufHolder

toString

public java.lang.String toString()

覆盖:

toString 在类中 DefaultByteBufHolder

retain

public WebSocketFrame retain()

从接口复制的说明: ReferenceCounted

Increases the reference count by 1.

指定者:

retain 在接口中 ByteBufHolder

指定者:

retain 在接口中 ReferenceCounted

覆盖:

retain 在类中 DefaultByteBufHolder

retain

public WebSocketFrame retain(int increment)

从接口复制的说明: ReferenceCounted

Increases the reference count by the specified increment.

指定者:

retain 在接口中 ByteBufHolder

指定者:

retain 在接口中 ReferenceCounted

覆盖:

retain 在类中 DefaultByteBufHolder

touch

public WebSocketFrame 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 在类中 DefaultByteBufHolder

touch

public WebSocketFrame 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 在类中 DefaultByteBufHolder