BinaryFrame (Jetty :: Project 9.4.56.v20240826 API)

java.lang.Object
- org.eclipse.jetty.websocket.common.WebSocketFrame
- - org.eclipse.jetty.websocket.common.frames.DataFrame
  - - org.eclipse.jetty.websocket.common.frames.BinaryFrame

All Implemented Interfaces:: Frame

public class BinaryFrame
extends DataFrame

Nested Class Summary
- Nested classes/interfaces inherited from interface org.eclipse.jetty.websocket.api.extensions.Frame
  Frame.Type

Field Summary
- Fields inherited from class org.eclipse.jetty.websocket.common.WebSocketFrame
  data, finRsvOp, mask, masked

Constructor Summary

Constructors
Constructor Description

BinaryFrame()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Frame.Type`	`getType()`
`BinaryFrame`	`setPayload(byte[] buf)`
`BinaryFrame`	`setPayload(java.lang.String payload)`
`BinaryFrame`	`setPayload(java.nio.ByteBuffer buf)`	Set the data payload.

Methods inherited from class org.eclipse.jetty.websocket.common.frames.DataFrame
assertValid, isControlFrame, isDataFrame, setIsContinuation

Methods inherited from class org.eclipse.jetty.websocket.common.WebSocketFrame
copy, copyHeaders, copyHeaders, equals, getMask, getOpCode, getPayload, getPayloadAsUTF8, getPayloadLength, hashCode, hasPayload, isFin, isLast, isMasked, isRsv1, isRsv2, isRsv3, reset, setFin, setMask, setMasked, setOpCode, setRsv1, setRsv2, setRsv3, toString

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BinaryFrame
```
public BinaryFrame()
```
- Method Detail
  - setPayload
```
public BinaryFrame setPayload(java.nio.ByteBuffer buf)
```
    Description copied from class: WebSocketFrame
    
    Set the data payload.
    The provided buffer will be used as is, no copying of bytes performed.
    The provided buffer should be flipped and ready to READ from.
    
    Overrides:
    
    setPayload in class WebSocketFrame
    
    Parameters:
    
    buf - the bytebuffer to set
    
    Returns:
    
    the frame itself
  - setPayload
```
public BinaryFrame setPayload(byte[] buf)
```
  - setPayload
```
public BinaryFrame setPayload(java.lang.String payload)
```
  - getType
```
public Frame.Type getType()
```
    Specified by:
    
    getType in interface Frame
    
    Overrides:
    
    getType in class WebSocketFrame