org.snf4j.websocket.frame

Class Frame

java.lang.Object

org.snf4j.websocket.frame.Frame

Direct Known Subclasses:

ControlFrame, DataFrame

public class Frame
extends Object

Base class for all Web Socket frames.

Author:

SNF4J.ORG

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	payload Payload data
static int	RSV1 The reserved bit 1
static int	RSV2 The reserved bit 2
static int	RSV3 The reserved bit 3

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Frame(Opcode opcode, boolean finalFragment, int rsvBits, byte[] payload) Constructs a generic Web Socket frame.

Method Summary

Modifier and Type	Method and Description
Opcode	getOpcode() Returns the type (opcode) of this frame.
byte[]	getPayload() Returns the payload data in this frame.
int	getPayloadLength() Return the length of the payload data in this frame.
int	getRsvBits() Returns the reserved bits for extensions or future versions.
boolean	isFinalFragment() Tells if this frame is the final fragment in a message.
boolean	isRsvBit1() Tells if the reserved bit 1 is set
boolean	isRsvBit2() Tells if the reserved bit 2 is set
boolean	isRsvBit3() Tells if the reserved bit 3 is set

Methods inherited from class java.lang.Object

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

Field Detail

RSV1

public static final int RSV1

The reserved bit 1

See Also:

Constant Field Values

RSV2

public static final int RSV2

The reserved bit 2

See Also:

Constant Field Values

RSV3

public static final int RSV3

The reserved bit 3

See Also:

Constant Field Values

payload

protected final byte[] payload

Payload data

Constructor Detail

Frame

protected Frame(Opcode opcode,
                boolean finalFragment,
                int rsvBits,
                byte[] payload)

Constructs a generic Web Socket frame.

Parameters:

opcode - the type of created frame

finalFragment - determines if the created frame is the final fragment in a message

rsvBits - reserved bits for extensions or future versions

payload - payload data

Method Detail

isFinalFragment

public boolean isFinalFragment()

Tells if this frame is the final fragment in a message.

Returns:

true if this frame is the final fragment

getRsvBits

public int getRsvBits()

Returns the reserved bits for extensions or future versions.

Returns:

the reserved bits

isRsvBit1

public boolean isRsvBit1()

Tells if the reserved bit 1 is set

Returns:

true if the reserved bit 1 is set

isRsvBit2

public boolean isRsvBit2()

Tells if the reserved bit 2 is set

Returns:

true if the reserved bit 2 is set

isRsvBit3

public boolean isRsvBit3()

Tells if the reserved bit 3 is set

Returns:

true if the reserved bit 3 is set

getOpcode

public Opcode getOpcode()

Returns the type (opcode) of this frame.

Returns:

the type of this frame

getPayload

public byte[] getPayload()

Returns the payload data in this frame.

Returns:

the payload data

getPayloadLength

public int getPayloadLength()

Return the length of the payload data in this frame.

Returns:

the lenght of the payload data