Frame (Jetty :: Project 9.4.56.v20240826 API)

All Known Implementing Classes:

BinaryFrame, CloseFrame, ContinuationFrame, ControlFrame, DataFrame, PingFrame, PongFrame, ReadOnlyDelegatedFrame, TextFrame, WebSocketFrame
```
public interface Frame
```
An immutable websocket frame.

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static class Frame.Type

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method	Description
`byte[]`	`getMask()`
`byte`	`getOpCode()`
`java.nio.ByteBuffer`	`getPayload()`
`int`	`getPayloadLength()`	The original payload length (`Buffer.remaining()`)
`Frame.Type`	`getType()`
`boolean`	`hasPayload()`
`boolean`	`isFin()`
`boolean`	`isLast()`	Deprecated. use `isFin()` instead
`boolean`	`isMasked()`
`boolean`	`isRsv1()`
`boolean`	`isRsv2()`
`boolean`	`isRsv3()`

- Method Detail
  - getMask
```
byte[] getMask()
```
  - getOpCode
```
byte getOpCode()
```
  - getPayload
```
java.nio.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
```
@Deprecated
boolean isLast()
```
    Deprecated.
    use isFin() instead
    
    Same as isFin()
    
    Returns:
    
    true if final frame.
  - isMasked
```
boolean isMasked()
```
  - isRsv1
```
boolean isRsv1()
```
  - isRsv2
```
boolean isRsv2()
```
  - isRsv3
```
boolean isRsv3()
```