io.netty.handler.codec.http.websocketx

Class PingWebSocketFrame

java.lang.Object

io.netty.buffer.DefaultByteBufHolder

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

io.netty.handler.codec.http.websocketx.PingWebSocketFrame

All Implemented Interfaces:

ByteBufHolder, ReferenceCounted

public class PingWebSocketFrame
extends WebSocketFrame

Web Socket frame containing binary data

Constructor Summary

Constructors

Constructor and Description
PingWebSocketFrame() Creates a new empty ping frame.
PingWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData) Creates a new ping frame with the specified binary data
PingWebSocketFrame(ByteBuf binaryData) Creates a new ping frame with the specified binary data.

Method Summary

Methods

Modifier and Type	Method and Description
PingWebSocketFrame	copy() Create a deep copy of this ByteBufHolder.
PingWebSocketFrame	duplicate() Duplicate the ByteBufHolder.
PingWebSocketFrame	retain() Increases the reference count by 1.
PingWebSocketFrame	retain(int increment) Increases the reference count by the specified increment.
PingWebSocketFrame	touch() Records the current access location of this object for debugging purposes.
PingWebSocketFrame	touch(Object hint) Records the current access location of this object with an additonal arbitrary information for debugging purposes.

Methods inherited from class io.netty.handler.codec.http.websocketx.WebSocketFrame

isFinalFragment, rsv, toString

Methods inherited from class io.netty.buffer.DefaultByteBufHolder

content, refCnt, release, release

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PingWebSocketFrame

public PingWebSocketFrame()

Creates a new empty ping frame.

PingWebSocketFrame

public PingWebSocketFrame(ByteBuf binaryData)

Creates a new ping frame with the specified binary data.

Parameters:

binaryData - the content of the frame.

PingWebSocketFrame

public PingWebSocketFrame(boolean finalFragment,
                  int rsv,
                  ByteBuf binaryData)

Creates a new ping frame with the specified binary data

Parameters:

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

binaryData - the content of the frame.

Method Detail

copy

public PingWebSocketFrame copy()

Description copied from interface: ByteBufHolder

Create a deep copy of this ByteBufHolder.

Specified by:

copy in interface ByteBufHolder

Specified by:

copy in class WebSocketFrame

duplicate

public PingWebSocketFrame 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

Specified by:

duplicate in class WebSocketFrame

retain

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

retain

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

touch

public PingWebSocketFrame touch()

Description copied from interface: 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).

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class WebSocketFrame

touch

public PingWebSocketFrame touch(Object hint)

Description copied from interface: ReferenceCounted

Records the current access location of this object with an additonal 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.

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class WebSocketFrame