Package 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:

io.netty.buffer.ByteBufHolder, io.netty.util.ReferenceCounted

Direct Known Subclasses:

BinaryWebSocketFrame, CloseWebSocketFrame, ContinuationWebSocketFrame, PingWebSocketFrame, PongWebSocketFrame, TextWebSocketFrame

public abstract class WebSocketFrame
extends io.netty.buffer.DefaultByteBufHolder

Base class for web socket frames.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebSocketFrame(boolean finalFragment, int rsv, io.netty.buffer.ByteBuf binaryData)
protected	WebSocketFrame(io.netty.buffer.ByteBuf binaryData)

Method Summary

Modifier and Type	Method	Description
WebSocketFrame	copy()
WebSocketFrame	duplicate()
boolean	isFinalFragment()	Flag to indicate if this frame is the final fragment in a message.
abstract WebSocketFrame	replace(io.netty.buffer.ByteBuf content)
WebSocketFrame	retain()
WebSocketFrame	retain(int increment)
WebSocketFrame	retainedDuplicate()
int	rsv()	Bits used for extensions to the standard.
String	toString()
WebSocketFrame	touch()
WebSocketFrame	touch(Object hint)

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

WebSocketFrame

protected WebSocketFrame(io.netty.buffer.ByteBuf binaryData)

WebSocketFrame

protected WebSocketFrame(boolean finalFragment,
                         int rsv,
                         io.netty.buffer.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 WebSocketFrame copy()

Specified by:

copy in interface io.netty.buffer.ByteBufHolder

Overrides:

copy in class io.netty.buffer.DefaultByteBufHolder

duplicate

public WebSocketFrame duplicate()

Specified by:

duplicate in interface io.netty.buffer.ByteBufHolder

Overrides:

duplicate in class io.netty.buffer.DefaultByteBufHolder

retainedDuplicate

public WebSocketFrame retainedDuplicate()

Specified by:

retainedDuplicate in interface io.netty.buffer.ByteBufHolder

Overrides:

retainedDuplicate in class io.netty.buffer.DefaultByteBufHolder

replace

public abstract WebSocketFrame replace(io.netty.buffer.ByteBuf content)

Specified by:

replace in interface io.netty.buffer.ByteBufHolder

Overrides:

replace in class io.netty.buffer.DefaultByteBufHolder

toString

public String toString()

Overrides:

toString in class io.netty.buffer.DefaultByteBufHolder

retain

public WebSocketFrame retain()

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.util.ReferenceCounted

Overrides:

retain in class io.netty.buffer.DefaultByteBufHolder

retain

public WebSocketFrame retain(int increment)

Specified by:

retain in interface io.netty.buffer.ByteBufHolder

Specified by:

retain in interface io.netty.util.ReferenceCounted

Overrides:

retain in class io.netty.buffer.DefaultByteBufHolder

touch

public WebSocketFrame touch()

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface io.netty.util.ReferenceCounted

Overrides:

touch in class io.netty.buffer.DefaultByteBufHolder

touch

public WebSocketFrame touch(Object hint)

Specified by:

touch in interface io.netty.buffer.ByteBufHolder

Specified by:

touch in interface io.netty.util.ReferenceCounted

Overrides:

touch in class io.netty.buffer.DefaultByteBufHolder