Package org.eclipse.jetty.websocket.api

Interface Frame

All Known Implementing Classes:

JettyWebSocketFrame

public interface Frame

An immutable websocket frame.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Frame.Type

Method Summary

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

Method Details

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()

isMasked

boolean isMasked()

isRsv1

boolean isRsv1()

isRsv2

boolean isRsv2()

isRsv3

boolean isRsv3()