Module io.netty5.codec.http

Package io.netty5.handler.codec.http.websocketx

Class TextWebSocketFrame

java.lang.Object

io.netty5.buffer.api.BufferHolder<WebSocketFrame>

io.netty5.handler.codec.http.websocketx.WebSocketFrame

io.netty5.handler.codec.http.websocketx.TextWebSocketFrame

All Implemented Interfaces:

Resource<WebSocketFrame>, AutoCloseable

public class TextWebSocketFrame
extends WebSocketFrame

Web Socket text frame.

Constructor Summary

Constructors

Constructor	Description
TextWebSocketFrame(boolean finalFragment, int rsv, Buffer binaryData)	Creates a new text frame with the specified binary data and the final fragment flag.
TextWebSocketFrame(Buffer binaryData)	Creates a new text frame with the specified binary data.
TextWebSocketFrame(BufferAllocator allocator, boolean finalFragment, int rsv, String text)	Creates a new text frame with the specified text string.
TextWebSocketFrame(BufferAllocator allocator, String text)	Creates a new text frame with the specified text string.

Method Summary

Modifier and Type	Method	Description
protected WebSocketFrame	receive(Buffer buf)	Called when a sent BufferHolder is received by the recipient.
String	text()	Returns the text data in this frame.

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

TextWebSocketFrame

public TextWebSocketFrame(BufferAllocator allocator,
                          String text)

Creates a new text frame with the specified text string. The final fragment flag is set to true.

Parameters:

allocator - BufferAllocator to use for allocating data.

text - String to put in the frame.

TextWebSocketFrame

public TextWebSocketFrame(Buffer binaryData)

Creates a new text frame with the specified binary data. The final fragment flag is set to true.

Parameters:

binaryData - the content of the frame.

TextWebSocketFrame

public TextWebSocketFrame(BufferAllocator allocator,
                          boolean finalFragment,
                          int rsv,
                          String text)

Creates a new text frame with the specified text string. The final fragment flag is set to true.

Parameters:

allocator - BufferAllocator to use for allocating data.

finalFragment - flag indicating if this frame is the final fragment

rsv - reserved bits used for protocol extensions

text - String to put in the frame.

TextWebSocketFrame

public TextWebSocketFrame(boolean finalFragment,
                          int rsv,
                          Buffer binaryData)

Creates a new text 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

text

public String text()

Returns the text data in this frame.

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.