com.dkfqs.tools.websocket

Class Frame

java.lang.Object

com.dkfqs.tools.websocket.Frame

public class Frame
extends java.lang.Object

A WebSocket frame. Note that this implementation cannot deal with payload data larger than Integer.MAX_VALUE bytes.

    0                   1                   2                   3
    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   +-+-+-+-+-------+-+-------------+-------------------------------+
   |F|R|R|R| opcode|M| Payload len |    Extended payload length    |
   |I|S|S|S|  (4)  |A|     (7)     |             (16/64)           |
   |N|V|V|V|       |S|             |   (if payload len==126/127)   |
   | |1|2|3|       |K|             |                               |
   +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
   |     Extended payload length continued, if payload len == 127  |
   + - - - - - - - - - - - - - - - +-------------------------------+
   |                               |Masking-key, if MASK set to 1  |
   +-------------------------------+-------------------------------+
   | Masking-key (continued)       |          Payload Data         |
   +-------------------------------- - - - - - - - - - - - - - - - +
   :                     Payload Data continued ...                :
   + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
   |                     Payload Data continued ...                |
   +---------------------------------------------------------------+
 

Field Summary

Fields

Modifier and Type	Field and Description
static byte	OPCODE_BINARY
static byte	OPCODE_CLOSE
static byte	OPCODE_CONTINUE
static byte	OPCODE_PING
static byte	OPCODE_PONG
static byte	OPCODE_TEXT

Constructor Summary

Constructors

Constructor and Description
Frame() Constructor: Create a new frame which can be send to a WebSocket client or server.
Frame(java.io.PushbackInputStream in) Constructor: Receive a frame from a WebSocket client or server.

Method Summary

Modifier and Type	Method and Description
byte[]	compileFrame() Compile a full binary frame which can be send directly to a WebSocket client or server.
java.lang.String	getAsciiDump() Get a ASCII dump of the frame.
long	getBytesReceived() Get the total number of bytes of the frame that have received, inclusive the frame overhead (performance data)
byte[]	getExtendedPayloadLength() Get the extended payload length.
byte	getFinRsvOpcode() Get the first byte of the frame containing the fin flag and the opcode.
java.lang.String	getHexDump() Get a HEX dump of the frame.
byte[]	getMaskingKey() Get the masking key.
byte	getMaskPayload() Get the second byte of the frame containing the mask flag and the 7-bit payload length
byte	getOpcode() Get the opcode.
byte[]	getPayload() Get the payload data.
long	getPayloadLength() Get the payload length.
long	getReceiveFrameStartNanoTime() Get the nano time when the first byte of the frame was received (performance data).
long	getReceiveFrameStartTime() Get the time when the first byte of the frame was received (performance data).
boolean	hasMaskingKey() Get it the mask flag is set.
boolean	isFin() Get if the fine flag is set.
static java.lang.String	opcodeToString(byte opcode) Convert an opcode to a string that can be printed out.
void	setFin(boolean fin) Set or clear the fin flag.
void	setMaskingKey(byte[] mKey) Set the masking flag and the masking key, and mask the payload.
void	setOpcode(byte opcode) Set the opcode.
void	setPayload(byte[] b) Set the payload.
static byte[]	xorData(byte[] data, byte[] xorKey) Perform an XOR operation on a byte array.

Methods inherited from class java.lang.Object

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

Field Detail

OPCODE_CONTINUE

public static final byte OPCODE_CONTINUE

See Also:

Constant Field Values

OPCODE_TEXT

public static final byte OPCODE_TEXT

See Also:

Constant Field Values

OPCODE_BINARY

public static final byte OPCODE_BINARY

See Also:

Constant Field Values

OPCODE_CLOSE

public static final byte OPCODE_CLOSE

See Also:

Constant Field Values

OPCODE_PING

public static final byte OPCODE_PING

See Also:

Constant Field Values

OPCODE_PONG

public static final byte OPCODE_PONG

See Also:

Constant Field Values

Constructor Detail

Frame

public Frame()

Constructor: Create a new frame which can be send to a WebSocket client or server. Example:

 Frame frame = new Frame();
 frame.setFin(true);
 frame.setOpcode(Frame.OPCODE_TEXT);
 frame.setPayload("Hello from EchoClient".getBytes("UTF-8"));
 frame.setMaskingKey(random.get4ByteRandom());
 byte[] frameData = frame.compileFrame();
 

Frame

public Frame(java.io.PushbackInputStream in)
      throws java.io.IOException

Constructor: Receive a frame from a WebSocket client or server.

Parameters:

in - the PushbackInputStream of the network connection

Throws:

java.io.IOException - if the network connection is unexpectedly closed, or if an invalid opcode is received, or if an unsupported payload length is received

Method Detail

setFin

public void setFin(boolean fin)

Set or clear the fin flag.

Parameters:

fin - true = set fin flag, false clear fin flag

isFin

public boolean isFin()

Get if the fine flag is set.

Returns:

true if the fine flag is set

setOpcode

public void setOpcode(byte opcode)

Set the opcode.

Parameters:

opcode - the opcode to set.

See Also:

OPCODE_CONTINUE, OPCODE_TEXT, OPCODE_BINARY, OPCODE_CLOSE, OPCODE_PING, OPCODE_PONG

getOpcode

public byte getOpcode()

Get the opcode.

Returns:

the opcode

See Also:

OPCODE_CONTINUE, OPCODE_TEXT, OPCODE_BINARY, OPCODE_CLOSE, OPCODE_PING, OPCODE_PONG

opcodeToString

public static java.lang.String opcodeToString(byte opcode)

Convert an opcode to a string that can be printed out.

Parameters:

opcode - the opcode

Returns:

the string of the opcode

getFinRsvOpcode

public byte getFinRsvOpcode()

Get the first byte of the frame containing the fin flag and the opcode.

Returns:

the first byte of the frame containing the fin flag and the opcode.

getMaskPayload

public byte getMaskPayload()

Get the second byte of the frame containing the mask flag and the 7-bit payload length

Returns:

the second byte of the frame containing the mask flag and the 7-bit payload length

getExtendedPayloadLength

public byte[] getExtendedPayloadLength()

Get the extended payload length.

Returns:

the extended payload length: 0, 2 or 8 bytes.

getPayload

public byte[] getPayload()

Get the payload data.

Returns:

the payload data

setPayload

public void setPayload(byte[] b)

Set the payload.

Parameters:

b - the payload

getPayloadLength

public long getPayloadLength()

Get the payload length.

Returns:

the payload length

hasMaskingKey

public boolean hasMaskingKey()

Get it the mask flag is set.

Returns:

true if the mask flag is set

getMaskingKey

public byte[] getMaskingKey()

Get the masking key.

Returns:

the masking key: 0 or 4 bytes

setMaskingKey

public void setMaskingKey(byte[] mKey)

Set the masking flag and the masking key, and mask the payload. Note that the payload has to be set first before calling this method.

Parameters:

mKey - the masking key: 4 bytes

Throws:

java.lang.IllegalArgumentException - if the masking key contains less or more than 4 bytes

See Also:

setPayload(byte[])

xorData

public static byte[] xorData(byte[] data,
                             byte[] xorKey)

Perform an XOR operation on a byte array.

Parameters:

data - the input data (byte array) on which the XOR operation is applied

xorKey - the XOR key, a byte[4] array

Returns:

the result byte array XOR-ed

compileFrame

public byte[] compileFrame()

Compile a full binary frame which can be send directly to a WebSocket client or server.

Returns:

the full binary frame which can be send directly to a WebSocket client or server

getReceiveFrameStartTime

public long getReceiveFrameStartTime()

Get the time when the first byte of the frame was received (performance data).

Returns:

the time when the first byte of the frame was received (Unix timestamp), or -1 if no such data is available

getReceiveFrameStartNanoTime

public long getReceiveFrameStartNanoTime()

Get the nano time when the first byte of the frame was received (performance data).

Returns:

the nano time when the first byte of the frame was received, or -1 if no such data is available

getBytesReceived

public long getBytesReceived()

Get the total number of bytes of the frame that have received, inclusive the frame overhead (performance data)

Returns:

the total number of bytes of the frame that have received, inclusive the frame overhead

getHexDump

public java.lang.String getHexDump()

Get a HEX dump of the frame.

Returns:

a HEX dump of the frame

getAsciiDump

public java.lang.String getAsciiDump()

Get a ASCII dump of the frame.

Returns:

a ASCII dump of the frame