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

Modifier and Type	Method	Description
PingWebSocketFrame	copy()	Creates a deep copy of this ByteBufHolder.
PingWebSocketFrame	duplicate()	Duplicates this ByteBufHolder.
PingWebSocketFrame	replace(ByteBuf content)	Returns a new ByteBufHolder which contains the specified content.
PingWebSocketFrame	retain()	Increases the reference count by 1.
PingWebSocketFrame	retain(int increment)	Increases the reference count by the specified increment.
PingWebSocketFrame	retainedDuplicate()	Duplicates this ByteBufHolder.
PingWebSocketFrame	touch()	Records the current access location of this object for debugging purposes.
PingWebSocketFrame	touch(java.lang.Object hint)	Records the current access location of this object with an additional 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, contentToString, equals, hashCode, refCnt, release, release

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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 class: DefaultByteBufHolder

Creates a deep copy of this ByteBufHolder.

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

Specified by:

copy in interface ByteBufHolder

Overrides:

copy in class WebSocketFrame

duplicate

public PingWebSocketFrame duplicate()

Description copied from class: DefaultByteBufHolder

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

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

Specified by:

duplicate in interface ByteBufHolder

Overrides:

duplicate in class WebSocketFrame

retainedDuplicate

public PingWebSocketFrame retainedDuplicate()

Description copied from class: DefaultByteBufHolder

Duplicates this ByteBufHolder. This method returns a retained duplicate unlike ByteBufHolder.duplicate().

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

Specified by:

retainedDuplicate in interface ByteBufHolder

Overrides:

retainedDuplicate in class WebSocketFrame

See Also:

ByteBuf.retainedDuplicate()

replace

public PingWebSocketFrame replace(ByteBuf content)

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

Specified by:

replace in interface ByteBufHolder

Specified by:

replace 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(java.lang.Object hint)

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

Specified by:

touch in interface ByteBufHolder

Specified by:

touch in interface ReferenceCounted

Overrides:

touch in class WebSocketFrame