Package org.threadly.litesockets.protocols.websocket

Class WSFrame

java.lang.Object

org.threadly.litesockets.protocols.websocket.WSFrame

public class WSFrame
extends java.lang.Object

WSFrame object. This is allows you to easily get information about a WebSocket Frame data. This object is immutable.

Method Summary

Modifier and Type	Method	Description
byte[]	getMaskArray()	Gets the mask as a byte array.
int	getMaskValue()	Gets the int used to mask this payload.
int	getOpCode()	The opCode for this websocket frame.
long	getPayloadDataLength()	Returns the size of the websocket frames payload
java.nio.ByteBuffer	getRawFrame()	ByteBuffer for the raw frame.
boolean	hasMask()	Is the mask bit set for this WSFrames payload.
boolean	hasRSV1()	Is the RSV1 bit set.
boolean	hasRSV2()	Is the RSV2 bit set.
boolean	hasRSV3()	Is the RSV3 bit set.
boolean	isFinished()	Is the finished bit set in the frame.
static WSFrame	makeWSFrame(int size, boolean isFinished, byte opCode, boolean mask)	Creates a WSFrame object with the provided parameters.
static WSFrame	makeWSFrame(int size, byte opCode, boolean mask)	Creates a WSFrame object with the provided parameters.
static WSFrame	makeWSFrame(int size, WSOPCode opCode, boolean mask)	Creates a WSFrame object with the provided parameters.
static WSFrame	parseWSFrame(java.nio.ByteBuffer bb)	Parses a WebSocket frame out of the provided ByteBuffer.
static WSFrame	parseWSFrame(org.threadly.litesockets.buffers.MergedByteBuffers mbb)	Parses a WebSocket frame from the passed in MergedByteBuffers.
java.nio.ByteBuffer	unmaskPayload(java.nio.ByteBuffer nbb)	Takes a ByteBuffer if this WSFrames payload and unmasks it.

Methods inherited from class java.lang.Object

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

Method Detail

getRawFrame

public java.nio.ByteBuffer getRawFrame()

ByteBuffer for the raw frame. This is just the frame, not the payload thats associated with it.

Returns:

ByteBuffer of this frame.

isFinished

public boolean isFinished()

Is the finished bit set in the frame.

Returns:

true if the frame is marked as finished, false if not.

hasRSV1

public boolean hasRSV1()

Is the RSV1 bit set.

Returns:

true if its set false if its not.

hasRSV2

public boolean hasRSV2()

Is the RSV2 bit set.

Returns:

true if its set false if its not.

hasRSV3

public boolean hasRSV3()

Is the RSV3 bit set.

Returns:

true if its set false if its not.

getOpCode

public int getOpCode()

The opCode for this websocket frame.

Returns:

The opCode for this websocket frame.

hasMask

public boolean hasMask()

Is the mask bit set for this WSFrames payload.

Returns:

true if the payload is masked, false if it is not.

getPayloadDataLength

public long getPayloadDataLength()

Returns the size of the websocket frames payload

Returns:

size of the payload.

getMaskValue

public int getMaskValue()

Gets the int used to mask this payload.

Returns:

the int used to mask the payload.

getMaskArray

public byte[] getMaskArray()

Gets the mask as a byte array.

Returns:

the make bytes as an array.

unmaskPayload

public java.nio.ByteBuffer unmaskPayload(java.nio.ByteBuffer nbb)

Takes a ByteBuffer if this WSFrames payload and unmasks it.

Parameters:

nbb - the ByteBuffer payload of this WSFrame.

Returns:

a ByteBuffer of the data unmasked.

parseWSFrame

public static WSFrame parseWSFrame(java.nio.ByteBuffer bb)
                            throws java.text.ParseException

Parses a WebSocket frame out of the provided ByteBuffer.

Parameters:

bb - the ByteBuffer containing the WebSocketFrame.

Returns:

a WSFrame.

Throws:

java.text.ParseException - this is thrown if there is not enough data to make a WSFrame.

parseWSFrame

public static WSFrame parseWSFrame(org.threadly.litesockets.buffers.MergedByteBuffers mbb)
                            throws java.text.ParseException

Parses a WebSocket frame from the passed in MergedByteBuffers. Only the data for the frame will be parsed out of the ByteBuffer, the payload will remain.

Parameters:

mbb - MergedByteBuffers containing the frame as the first bytes.

Returns:

a WSFrame object to get info about the data in the WSFrame.

Throws:

java.text.ParseException - this is thrown if there is not enough data to make a WSFrame.

makeWSFrame

public static WSFrame makeWSFrame(int size,
                                  byte opCode,
                                  boolean mask)

Creates a WSFrame object with the provided parameters.

Parameters:

size - the size of the payload in the WebSocket Frame.

opCode - The opCode to put in this WebSocket.

mask - true if a mask should be added to this frame, false if not.

Returns:

a WSFrame object created with the provided params.

makeWSFrame

public static WSFrame makeWSFrame(int size,
                                  WSOPCode opCode,
                                  boolean mask)

Creates a WSFrame object with the provided parameters.

Parameters:

size - the size of the payload in the WSFrame.

opCode - The WSOPCode to use in this WSFrame.

mask - true if a mask should be added to this frame, false if not.

Returns:

a WSFrame object created with the provided params.

makeWSFrame

public static WSFrame makeWSFrame(int size,
                                  boolean isFinished,
                                  byte opCode,
                                  boolean mask)

Creates a WSFrame object with the provided parameters.

Parameters:

size - the size of the payload in the WSFrame.

isFinished - true if we should mark this WSFrame as finished false if not.

opCode - The opCode to put in this WebSocket.

mask - true if a mask should be added to this frame, false if not.

Returns:

a WSFrame object created with the provided params.