Top Description Constructors Methods
io.netty.handler.codec.http.websocketx

public Class PingWebSocketFrame

extends WebSocketFrame
Class Inheritance
Imports
io.netty.buffer.ByteBuf, .Unpooled
Web Socket frame containing binary data.

Constructor Summary

AccessConstructor and Description
public
PingWebSocketFrame()

Creates a new empty ping frame.

public
PingWebSocketFrame(ByteBuf
the content of the frame.
binaryData)

Creates a new ping frame with the specified binary data.

public
PingWebSocketFrame(boolean
flag indicating if this frame is the final fragment
finalFragment, int
reserved bits used for protocol extensions
rsv, ByteBuf
the content of the frame.
binaryData)

Creates a new ping frame with the specified binary data.

Method Summary

Modifier and TypeMethod and Description
public PingWebSocketFrame
copy()

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

Implements io.netty.buffer.ByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.
public PingWebSocketFrame
duplicate()

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

Implements io.netty.buffer.ByteBufHolder.duplicate.

Duplicates this ByteBufHolder.
public PingWebSocketFrame
replace(ByteBuf content)

Implements abstract io.netty.handler.codec.http.websocketx.WebSocketFrame.replace.

Implements io.netty.buffer.ByteBufHolder.replace.

Returns a new ByteBufHolder which contains the specified content.
public PingWebSocketFrame
retain()

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

Implements io.netty.buffer.ByteBufHolder.retain.

Increases the reference count by 1.
public PingWebSocketFrame
retain(int increment)

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

Implements io.netty.buffer.ByteBufHolder.retain.

Increases the reference count by the specified increment.
public PingWebSocketFrame
retainedDuplicate()

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

Implements io.netty.buffer.ByteBufHolder.retainedDuplicate.

Duplicates this ByteBufHolder.
public PingWebSocketFrame
touch()

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

Implements io.netty.buffer.ByteBufHolder.touch.

Records the current access location of this object for debugging purposes.
public PingWebSocketFrame
touch(Object hint)

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

Implements io.netty.buffer.ByteBufHolder.touch.

Records the current access location of this object with an additional arbitrary information for debugging purposes.
Inherited from io.netty.handler.codec.http.websocketx.WebSocketFrame:
isFinalFragmentrsvtoString

Constructor Detail

PingWebSocketFrameback to summary
public PingWebSocketFrame()

Creates a new empty ping frame.

PingWebSocketFrameback to summary
public PingWebSocketFrame(ByteBuf binaryData)

Creates a new ping frame with the specified binary data.

Parameters
binaryData:ByteBuf

the content of the frame.

PingWebSocketFrameback to summary
public PingWebSocketFrame(boolean finalFragment, int rsv, ByteBuf binaryData)

Creates a new ping frame with the specified binary data.

Parameters
finalFragment:boolean

flag indicating if this frame is the final fragment

rsv:int

reserved bits used for protocol extensions

binaryData:ByteBuf

the content of the frame.

Method Detail

copyback to summary
public PingWebSocketFrame copy()

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

Implements io.netty.buffer.ByteBufHolder.copy.

Doc from io.netty.buffer.DefaultByteBufHolder.copy.

Creates a deep copy of this ByteBufHolder.

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

Annotations
@Override
duplicateback to summary
public PingWebSocketFrame duplicate()

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

Implements io.netty.buffer.ByteBufHolder.duplicate.

Doc from io.netty.buffer.DefaultByteBufHolder.duplicate.

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

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

Annotations
@Override
replaceback to summary
public PingWebSocketFrame replace(ByteBuf content)

Implements abstract io.netty.handler.codec.http.websocketx.WebSocketFrame.replace.

Implements io.netty.buffer.ByteBufHolder.replace.

Doc from io.netty.buffer.DefaultByteBufHolder.replace.

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 copy(), duplicate() and retainedDuplicate() invokes this method to create a copy.

Annotations
@Override
retainback to summary
public PingWebSocketFrame retain()

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

Implements io.netty.buffer.ByteBufHolder.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by 1.

Annotations
@Override
retainback to summary
public PingWebSocketFrame retain(int increment)

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

Implements io.netty.buffer.ByteBufHolder.retain.

Doc from io.netty.util.ReferenceCounted.retain.

Increases the reference count by the specified increment.

Annotations
@Override
retainedDuplicateback to summary
public PingWebSocketFrame retainedDuplicate()

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

Implements io.netty.buffer.ByteBufHolder.retainedDuplicate.

Doc from io.netty.buffer.DefaultByteBufHolder.retainedDuplicate.

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

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

Annotations
@Override
touchback to summary
public PingWebSocketFrame touch()

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

Implements io.netty.buffer.ByteBufHolder.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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).

Annotations
@Override
touchback to summary
public PingWebSocketFrame touch(Object hint)

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

Implements io.netty.buffer.ByteBufHolder.touch.

Doc from io.netty.util.ReferenceCounted.touch.

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.

Annotations
@Override