org.snf4j.websocket.frame

Class PingFrame

java.lang.Object

org.snf4j.websocket.frame.Frame

org.snf4j.websocket.frame.ControlFrame

org.snf4j.websocket.frame.PingFrame

public class PingFrame
extends ControlFrame

Web Socket ping frame.

Author:

SNF4J.ORG

Field Summary

Fields inherited from class org.snf4j.websocket.frame.Frame

payload, RSV1, RSV2, RSV3

Constructor Summary

Constructors

Constructor and Description
PingFrame() Constructs an empty Web Socket ping frame with all reserved bits cleared.
PingFrame(byte[] payload) Constructs a Web Socket ping frame with all reserved bits cleared.
PingFrame(int rsvBits, byte[] payload) Constructs a Web Socket ping frame.

Method Summary

Methods inherited from class org.snf4j.websocket.frame.Frame

getOpcode, getPayload, getPayloadLength, getRsvBits, isFinalFragment, isRsvBit1, isRsvBit2, isRsvBit3

Methods inherited from class java.lang.Object

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

Constructor Detail

PingFrame

public PingFrame(int rsvBits,
                 byte[] payload)

Constructs a Web Socket ping frame.

Parameters:

rsvBits - reserved bits for extensions or future versions

payload - payload data

Throws:

IllegalArgumentException - if the length of the payload data is greater than 125

PingFrame

public PingFrame(byte[] payload)

Constructs a Web Socket ping frame with all reserved bits cleared.

Parameters:

payload - payload data

Throws:

IllegalArgumentException - if the length of the payload data is greater than 125

PingFrame

public PingFrame()

Constructs an empty Web Socket ping frame with all reserved bits cleared.