org.eclipse.paho.client.mqttv3.internal.websocket

Class WebSocketFrame

java.lang.Object

org.eclipse.paho.client.mqttv3.internal.websocket.WebSocketFrame

public class WebSocketFrame
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	frameLengthOverhead

Constructor Summary

Constructors

Constructor and Description
WebSocketFrame(byte[] rawFrame) Initialise WebSocketFrame from raw Data
WebSocketFrame(byte opcode, boolean fin, byte[] payload) Initialise a new WebSocketFrame
WebSocketFrame(InputStream input) Takes an input stream and parses it into a Websocket frame.

Method Summary

Modifier and Type	Method and Description
static void	appendFinAndOpCode(ByteBuffer buffer, byte opcode, boolean fin) Appends the Fin flag and the OpCode
static void	appendLengthAndMask(ByteBuffer buffer, int length, byte[] mask) Appends the Length and Mask to the buffer
byte[]	encodeFrame() Encodes the this WebSocketFrame into a byte array.
static byte[]	generateMaskingKey() Generates a random masking key Nothing super secure, but enough for websockets.
byte	getOpcode()
byte[]	getPayload()
boolean	isCloseFlag()
boolean	isFin()

Methods inherited from class java.lang.Object

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

Field Detail

frameLengthOverhead

public static final int frameLengthOverhead

See Also:

Constant Field Values

Constructor Detail

WebSocketFrame

public WebSocketFrame(byte opcode,
                      boolean fin,
                      byte[] payload)

Initialise a new WebSocketFrame

Parameters:

opcode -

fin -

payload -

WebSocketFrame

public WebSocketFrame(byte[] rawFrame)

Initialise WebSocketFrame from raw Data

Parameters:

rawFrame -

WebSocketFrame

public WebSocketFrame(InputStream input)
               throws IOException

Takes an input stream and parses it into a Websocket frame.

Parameters:

input -

Throws:

IOException

Method Detail

getOpcode

public byte getOpcode()

isFin

public boolean isFin()

getPayload

public byte[] getPayload()

isCloseFlag

public boolean isCloseFlag()

encodeFrame

public byte[] encodeFrame()

Encodes the this WebSocketFrame into a byte array.

Returns:

byte array

appendLengthAndMask

public static void appendLengthAndMask(ByteBuffer buffer,
                                       int length,
                                       byte[] mask)

Appends the Length and Mask to the buffer

Parameters:

buffer -

length -

mask -

appendFinAndOpCode

public static void appendFinAndOpCode(ByteBuffer buffer,
                                      byte opcode,
                                      boolean fin)

Appends the Fin flag and the OpCode

Parameters:

buffer -

opcode -

fin -

generateMaskingKey

public static byte[] generateMaskingKey()

Generates a random masking key Nothing super secure, but enough for websockets.

Returns:

ByteArray containing the key;