Top Description Inners Methods
org.eclipse.jetty.websocket.api

public Interface Frame

Imports
java.nio.ByteBuffer
An immutable websocket frame.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
Frame.Type

Method Summary

Modifier and TypeMethod and Description
public byte[]
getMask()

public byte
getOpCode()

public ByteBuffer
getPayload()

public int

Returns:

the original payload length (ByteBuffer#remaining())
getPayloadLength()

The original payload length (ByteBuffer#remaining())

public Frame.Type
getType()

public boolean
hasPayload()

public boolean
isFin()

public boolean
isMasked()

public boolean
isRsv1()

public boolean
isRsv2()

public boolean
isRsv3()

Method Detail

getMaskback to summary
public byte[] getMask()
getOpCodeback to summary
public byte getOpCode()
getPayloadback to summary
public ByteBuffer getPayload()
getPayloadLengthback to summary
public int getPayloadLength()

The original payload length (ByteBuffer#remaining())

Returns:int

the original payload length (ByteBuffer#remaining())

getTypeback to summary
public Frame.Type getType()
hasPayloadback to summary
public boolean hasPayload()
isFinback to summary
public boolean isFin()
isMaskedback to summary
public boolean isMasked()
isRsv1back to summary
public boolean isRsv1()
isRsv2back to summary
public boolean isRsv2()
isRsv3back to summary
public boolean isRsv3()
org.eclipse.jetty.websocket.api back to summary

public final Enum Frame.Type

extends Enum<Frame.Type>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final Frame.Type
BINARY

public static final Frame.Type
CLOSE

public static final Frame.Type
CONTINUATION

private final byte
opcode

public static final Frame.Type
PING

public static final Frame.Type
PONG

public static final Frame.Type
TEXT

Constructor Summary

AccessConstructor and Description
private
Type(byte code)

Method Summary

Modifier and TypeMethod and Description
public static Frame.Type
from(byte op)

public byte
getOpCode()

public boolean
isContinuation()

public boolean
isControl()

public boolean
isData()

public String
toString()

Overrides java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration.

public static Frame.Type
valueOf(String name)

public static Frame.Type[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinalvalueOf

Field Detail

BINARYback to summary
public static final Frame.Type BINARY
CLOSEback to summary
public static final Frame.Type CLOSE
CONTINUATIONback to summary
public static final Frame.Type CONTINUATION
opcodeback to summary
private final byte opcode
PINGback to summary
public static final Frame.Type PING
PONGback to summary
public static final Frame.Type PONG
TEXTback to summary
public static final Frame.Type TEXT

Constructor Detail

Typeback to summary
private Type(byte code)

Method Detail

fromback to summary
public static Frame.Type from(byte op)
getOpCodeback to summary
public byte getOpCode()
isContinuationback to summary
public boolean isContinuation()
isControlback to summary
public boolean isControl()
isDataback to summary
public boolean isData()
toStringback to summary
public String toString()

Overrides java.lang.Enum.toString.

Doc from java.lang.Enum.toString.

Returns the name of this enum constant, as contained in the declaration. This method may be overridden, though it typically isn't necessary or desirable. An enum class should override this method when a more "programmer-friendly" string form exists.

Returns:String

the name of this enum constant

Annotations
@Override
valueOfback to summary
public static Frame.Type valueOf(String name)
valuesback to summary
public static Frame.Type[] values()