io.netty.handler.codec.http.websocketx

Class WebSocketFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

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

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted

Direct Known Subclasses:

BinaryWebSocketFrame, CloseWebSocketFrame, ContinuationWebSocketFrame, PingWebSocketFrame, PongWebSocketFrame, TextWebSocketFrame

public abstract class WebSocketFrame
extends DefaultByteBufHolder

Base class for web socket frames

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	finalFragment Flag to indicate if this frame is the final fragment in a message.
private int	rsv RSV1, RSV2, RSV3 used for extensions

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)
protected	WebSocketFrame(ByteBuf binaryData)

Method Summary

Modifier and Type	Method and Description
abstract WebSocketFrame	copy() Create a deep copy of this ByteBufHolder.
abstract WebSocketFrame	duplicate() Duplicate the ByteBufHolder.
boolean	isFinalFragment() Flag to indicate if this frame is the final fragment in a message.
WebSocketFrame	retain() Increases the reference count by 1.
WebSocketFrame	retain(int increment) Increases the reference count by the specified increment.
int	rsv() Bits used for extensions to the standard.
java.lang.String	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

Field Detail

finalFragment

private final boolean finalFragment

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

rsv

private final int rsv

RSV1, RSV2, RSV3 used for extensions

Constructor Detail

WebSocketFrame

protected WebSocketFrame(ByteBuf binaryData)

WebSocketFrame

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

Method Detail

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 abstract WebSocketFrame copy()

Description copied from interface: ByteBufHolder

Create a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

Overrides:

copy in class DefaultByteBufHolder

duplicate

public abstract WebSocketFrame duplicate()

Description copied from interface: ByteBufHolder

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

Specified by:

duplicate in interface ByteBufHolder

Overrides:

duplicate in class DefaultByteBufHolder

toString

public java.lang.String toString()

Overrides:

toString in class DefaultByteBufHolder

retain

public WebSocketFrame 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 DefaultByteBufHolder

retain

public WebSocketFrame 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 DefaultByteBufHolder