BinaryWebSocketFrame (Netty API Reference (5.0.0.Alpha4))

java.lang.Object
- io.netty5.buffer.api.BufferHolder<WebSocketFrame>
- - io.netty5.handler.codec.http.websocketx.WebSocketFrame
  - - io.netty5.handler.codec.http.websocketx.BinaryWebSocketFrame

All Implemented Interfaces:

Resource<WebSocketFrame>, AutoCloseable
```
public class BinaryWebSocketFrame
extends WebSocketFrame
```
Web Socket frame containing binary data.

Constructor Summary

Constructors
Constructor	Description
`BinaryWebSocketFrame(boolean finalFragment, int rsv, Buffer binaryData)`	Creates a new binary frame with the specified binary data and the final fragment flag.
`BinaryWebSocketFrame(Buffer binaryData)`	Creates a new binary frame with the specified binary data.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected WebSocketFrame`	`receive(Buffer buf)`	Called when a sent `BufferHolder` is received by the recipient.

Methods inherited from class io.netty5.handler.codec.http.websocketx.WebSocketFrame
binaryData, isFinalFragment, rsv, toString

Methods inherited from class io.netty5.buffer.api.BufferHolder
close, equals, getBuffer, getBufferVolatile, hashCode, isAccessible, replaceBuffer, replaceBufferVolatile, send, touch

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

- Constructor Detail
  - BinaryWebSocketFrame
```
public BinaryWebSocketFrame(Buffer binaryData)
```
    Creates a new binary frame with the specified binary data. The final fragment flag is set to true.
    
    Parameters:
    
    binaryData - the content of the frame.
  - BinaryWebSocketFrame
```
public BinaryWebSocketFrame(boolean finalFragment,
                            int rsv,
                            Buffer binaryData)
```
    Creates a new binary frame with the specified binary data and the final fragment flag.
    
    Parameters:
    
    finalFragment - flag indicating if this frame is the final fragment
    
    rsv - reserved bits used for protocol extensions
    
    binaryData - the content of the frame.
- Method Detail
  - receive
```
protected WebSocketFrame receive(Buffer buf)
```
    Description copied from class: BufferHolder
    
    Called when a sent BufferHolder is received by the recipient. The BufferHolder should return a new concrete instance, that wraps the given Buffer object.
    
    Specified by:
    
    receive in class BufferHolder<WebSocketFrame>
    
    Parameters:
    
    buf - The Buffer that is received by the recipient, and needs to be wrapped in a new BufferHolder instance.
    
    Returns:
    
    A new buffer holder instance, containing the given buffer.