org.eclipse.jetty.websocket.api.extensions

Interface Frame

All Known Implementing Classes:

BinaryFrame, CloseFrame, ContinuationFrame, ControlFrame, DataFrame, PingFrame, PongFrame, TextFrame, WebSocketFrame

public interface Frame

An immutable websocket frame.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Frame.Type

Method Summary

Methods

Modifier and Type	Method and Description
byte[]	getMask()
byte	getOpCode()
ByteBuffer	getPayload()
int	getPayloadLength() The original payload length (Buffer.remaining())
Frame.Type	getType()
boolean	hasPayload()
boolean	isFin()
boolean	isLast() Same as isFin()
boolean	isMasked()
boolean	isRsv1()
boolean	isRsv2()
boolean	isRsv3()

Method Detail

getMask

byte[] getMask()

getOpCode

byte getOpCode()

getPayload

ByteBuffer getPayload()

getPayloadLength

int getPayloadLength()

The original payload length (Buffer.remaining())

Returns:

the original payload length (Buffer.remaining())

getType

Frame.Type getType()

hasPayload

boolean hasPayload()

isFin

boolean isFin()

isLast

boolean isLast()

Same as isFin()

Returns:

true if final frame.

isMasked

boolean isMasked()

isRsv1

boolean isRsv1()

isRsv2

boolean isRsv2()

isRsv3

boolean isRsv3()