Package com.linecorp.armeria.common.websocket

Interface WebSocketFrame

All Superinterfaces:

AutoCloseable, Bytes, SafeCloseable

All Known Subinterfaces:

CloseWebSocketFrame

@UnstableApi
public interface WebSocketFrame
extends Bytes

A WebSocketFrame to send data to the peer.

See Also:

• Data framing

Method Summary

Modifier and Type	Method	Description
boolean	isFinalFragment()	Tells whether this frame is a final fragment or not.
static WebSocketFrame	ofBinary(byte[] data)	Returns a new binary WebSocketFrame whose isFinalFragment() is set to true.
static WebSocketFrame	ofBinary(byte[] data, boolean finalFragment)	Returns a new binary WebSocketFrame with the finalFragment.
static CloseWebSocketFrame	ofClose(byte[] data)	Returns a new CloseWebSocketFrame with the data that contains WebSocketCloseStatus.
static CloseWebSocketFrame	ofClose(WebSocketCloseStatus status)	Returns a new CloseWebSocketFrame with the WebSocketCloseStatus.
static CloseWebSocketFrame	ofClose(WebSocketCloseStatus status, String reason)	Returns a new CloseWebSocketFrame with the WebSocketCloseStatus and the reason.
static WebSocketFrame	ofContinuation(byte[] data)	Returns a new continuation WebSocketFrame whose isFinalFragment() is set to true.
static WebSocketFrame	ofContinuation(byte[] data, boolean finalFragment)	Returns a new continuation WebSocketFrame with the data and finalFragment.
static WebSocketFrame	ofContinuation(String text)	Returns a new text continuation WebSocketFrame whose isFinalFragment() is set to true.
static WebSocketFrame	ofContinuation(String text, boolean finalFragment)	Returns a new text continuation WebSocketFrame with the text and finalFragment.
static WebSocketFrame	ofPing()	Returns a ping WebSocketFrame.
static WebSocketFrame	ofPing(byte[] data)	Returns a new ping WebSocketFrame with the data.
static WebSocketFrame	ofPong()	Returns a pong WebSocketFrame.
static WebSocketFrame	ofPong(byte[] data)	Returns a new pong WebSocketFrame with the data.
static WebSocketFrame	ofPooledBinary(io.netty.buffer.ByteBuf data)	(Advanced users only) Returns a new binary WebSocketFrame with the ByteBuf whose isFinalFragment() is set to true.
static WebSocketFrame	ofPooledBinary(io.netty.buffer.ByteBuf data, boolean finalFragment)	(Advanced users only) Returns a new binary WebSocketFrame with the ByteBuf and finalFragment.
static CloseWebSocketFrame	ofPooledClose(io.netty.buffer.ByteBuf data)	(Advanced users only) Returns a new CloseWebSocketFrame with the ByteBuf.
static WebSocketFrame	ofPooledContinuation(io.netty.buffer.ByteBuf data)	(Advanced users only) Returns a new continuation WebSocketFrame with the ByteBuf whose isFinalFragment() is set to true.
static WebSocketFrame	ofPooledContinuation(io.netty.buffer.ByteBuf data, boolean finalFragment)	(Advanced users only) Returns a new binary WebSocketFrame with the ByteBuf and finalFragment.
static WebSocketFrame	ofPooledPing(io.netty.buffer.ByteBuf data)	(Advanced users only) Returns a new ping WebSocketFrame with the ByteBuf.
static WebSocketFrame	ofPooledPong(io.netty.buffer.ByteBuf data)	(Advanced users only) Returns a new pong WebSocketFrame with the ByteBuf.
static WebSocketFrame	ofPooledText(io.netty.buffer.ByteBuf text)	(Advanced users only) Returns a new text WebSocketFrame with the ByteBuf whose isFinalFragment() is set to true.
static WebSocketFrame	ofPooledText(io.netty.buffer.ByteBuf text, boolean finalFragment)	(Advanced users only) Returns a new text WebSocketFrame with the ByteBuf and finalFragment.
static WebSocketFrame	ofText(byte[] text)	Returns a new text WebSocketFrame with the UTF-8 encoded text whose isFinalFragment() is set to true.
static WebSocketFrame	ofText(byte[] text, boolean finalFragment)	Returns a new text WebSocketFrame with the UTF-8 encoded text and finalFragment.
static WebSocketFrame	ofText(String text)	Returns a new text WebSocketFrame with the text whose isFinalFragment() is set to true.
static WebSocketFrame	ofText(String text, boolean finalFragment)	Returns a new text WebSocketFrame with the text and finalFragment.
String	text()	Returns the text data in this frame.
WebSocketFrameType	type()	Returns the type of this frame.

Methods inherited from interface com.linecorp.armeria.common.Bytes

array, byteBuf, byteBuf, byteBuf, close, isEmpty, isPooled, length, toInputStream, toReader, toReaderAscii, toReaderUtf8, toString, toStringAscii, toStringUtf8, touch

Method Details

ofText

static WebSocketFrame ofText(String text)

Returns a new text WebSocketFrame with the text whose isFinalFragment() is set to true.

See Also:

• Data Frames

ofText

static WebSocketFrame ofText(String text,
 boolean finalFragment)

Returns a new text WebSocketFrame with the text and finalFragment. When the finalFragment is false, ofContinuation(byte[]) frames must be followed.

See Also:

• Data Frames

ofText

static WebSocketFrame ofText(byte[] text)

Returns a new text WebSocketFrame with the UTF-8 encoded text whose isFinalFragment() is set to true.

See Also:

• Data Frames

ofText

static WebSocketFrame ofText(byte[] text,
 boolean finalFragment)

Returns a new text WebSocketFrame with the UTF-8 encoded text and finalFragment. When the finalFragment is false, ofContinuation(byte[]) frames must be followed.

See Also:

• Data Frames

ofBinary

static WebSocketFrame ofBinary(byte[] data)

Returns a new binary WebSocketFrame whose isFinalFragment() is set to true.

See Also:

• Data Frames

ofBinary

static WebSocketFrame ofBinary(byte[] data,
 boolean finalFragment)

Returns a new binary WebSocketFrame with the finalFragment. When the finalFragment is false, ofContinuation(byte[]) frames must be followed.

See Also:

• Data Frames

ofClose

static CloseWebSocketFrame ofClose(WebSocketCloseStatus status)

Returns a new CloseWebSocketFrame with the WebSocketCloseStatus.

See Also:

• Close

ofClose

static CloseWebSocketFrame ofClose(WebSocketCloseStatus status,
 String reason)

Returns a new CloseWebSocketFrame with the WebSocketCloseStatus and the reason.

See Also:

• Close

ofClose

static CloseWebSocketFrame ofClose(byte[] data)

Returns a new CloseWebSocketFrame with the data that contains WebSocketCloseStatus.

See Also:

• Close

ofPing

static WebSocketFrame ofPing()

Returns a ping WebSocketFrame.

See Also:

• Ping

ofPing

static WebSocketFrame ofPing(byte[] data)

Returns a new ping WebSocketFrame with the data.

See Also:

• Ping

ofPong

static WebSocketFrame ofPong()

Returns a pong WebSocketFrame.

See Also:

• Pong

ofPong

static WebSocketFrame ofPong(byte[] data)

Returns a new pong WebSocketFrame with the data.

See Also:

• Pong

ofContinuation

static WebSocketFrame ofContinuation(byte[] data)

Returns a new continuation WebSocketFrame whose isFinalFragment() is set to true. isText must be true if this continuation frame follows a text frame. false if this follows a binary frame.

See Also:

• Fragmentation

ofContinuation

static WebSocketFrame ofContinuation(byte[] data,
 boolean finalFragment)

Returns a new continuation WebSocketFrame with the data and finalFragment. isText must be true if this continuation frame follows a text frame. false if this follows a binary frame.

See Also:

• Fragmentation

ofContinuation

static WebSocketFrame ofContinuation(String text)

Returns a new text continuation WebSocketFrame whose isFinalFragment() is set to true.

See Also:

• Fragmentation

ofContinuation

static WebSocketFrame ofContinuation(String text,
 boolean finalFragment)

Returns a new text continuation WebSocketFrame with the text and finalFragment.

See Also:

• Fragmentation

ofPooledText

static WebSocketFrame ofPooledText(io.netty.buffer.ByteBuf text)

(Advanced users only) Returns a new text WebSocketFrame with the ByteBuf whose isFinalFragment() is set to true.

See Also:

• ofText(byte[])
• PooledObjects

ofPooledText

static WebSocketFrame ofPooledText(io.netty.buffer.ByteBuf text,
 boolean finalFragment)

(Advanced users only) Returns a new text WebSocketFrame with the ByteBuf and finalFragment. When the finalFragment is false, ofPooledContinuation(ByteBuf) frames must be followed.

See Also:

• ofText(byte[])
• PooledObjects

ofPooledBinary

static WebSocketFrame ofPooledBinary(io.netty.buffer.ByteBuf data)

(Advanced users only) Returns a new binary WebSocketFrame with the ByteBuf whose isFinalFragment() is set to true.

See Also:

• ofBinary(byte[])
• PooledObjects

ofPooledBinary

static WebSocketFrame ofPooledBinary(io.netty.buffer.ByteBuf data,
 boolean finalFragment)

(Advanced users only) Returns a new binary WebSocketFrame with the ByteBuf and finalFragment. When the finalFragment is false, ofPooledContinuation(ByteBuf) frames must be followed.

See Also:

• ofBinary(byte[], boolean)
• PooledObjects

ofPooledClose

static CloseWebSocketFrame ofPooledClose(io.netty.buffer.ByteBuf data)

(Advanced users only) Returns a new CloseWebSocketFrame with the ByteBuf.

See Also:

• ofClose(byte[])
• PooledObjects

ofPooledPing

static WebSocketFrame ofPooledPing(io.netty.buffer.ByteBuf data)

(Advanced users only) Returns a new ping WebSocketFrame with the ByteBuf.

See Also:

• ofPing(byte[])
• PooledObjects

ofPooledPong

static WebSocketFrame ofPooledPong(io.netty.buffer.ByteBuf data)

(Advanced users only) Returns a new pong WebSocketFrame with the ByteBuf.

See Also:

• ofPong(byte[])
• PooledObjects

ofPooledContinuation

static WebSocketFrame ofPooledContinuation(io.netty.buffer.ByteBuf data)

(Advanced users only) Returns a new continuation WebSocketFrame with the ByteBuf whose isFinalFragment() is set to true. isText must be true if this continuation frame follows a text frame. false if this follows a binary frame.

See Also:

• ofContinuation(byte[])
• PooledObjects

ofPooledContinuation

static WebSocketFrame ofPooledContinuation(io.netty.buffer.ByteBuf data,
 boolean finalFragment)

(Advanced users only) Returns a new binary WebSocketFrame with the ByteBuf and finalFragment. isText must be true if this continuation frame follows a text frame. false if this follows a binary frame.

See Also:

• ofContinuation(byte[])
• PooledObjects

type

WebSocketFrameType type()

Returns the type of this frame.

isFinalFragment

boolean isFinalFragment()

Tells whether this frame is a final fragment or not.

See Also:

• ofContinuation(byte[])

text

String text()

Returns the text data in this frame.