Package com.linecorp.armeria.common.websocket

Interface WebSocketWriter

All Superinterfaces:

org.reactivestreams.Publisher<WebSocketFrame>, StreamMessage<WebSocketFrame>, StreamWriter<WebSocketFrame>, WebSocket

@UnstableApi
public interface WebSocketWriter
extends WebSocket, StreamWriter<WebSocketFrame>

A WebSocket that you can write WebSocketFrames to it. Use WebSocket.streaming() to construct.

Method Summary

Modifier and Type	Method	Description
void	close()	Sends the closing handshake with WebSocketCloseStatus.NORMAL_CLOSURE.
void	close(WebSocketCloseStatus status)	Sends the closing handshake with the WebSocketCloseStatus.
void	close(WebSocketCloseStatus status, String reasonPhrase)	Sends the closing handshake with the WebSocketCloseStatus and the reason.
void	close(Throwable cause)	Sends the closing handshake with the WebSocketCloseStatus.INTERNAL_SERVER_ERROR and Throwable.getMessage().
default boolean	tryWrite(byte[] data)	Writes a binary WebSocketFrame to this WebSocket.
default boolean	tryWrite(byte[] data, boolean finalFragment)	Writes a binary WebSocketFrame to this WebSocket.
default boolean	tryWrite(String text)	Writes a text WebSocketFrame to this WebSocket.
default boolean	tryWrite(String text, boolean finalFragment)	Writes a text WebSocketFrame to this WebSocket.
default void	write(byte[] data)	Writes a binary WebSocketFrame to this WebSocket.
default void	write(byte[] data, boolean finalFragment)	Writes a binary WebSocketFrame to this WebSocket whose WebSocketFrame.isFinalFragment() is set to finalFragment.
default void	write(String text)	Writes a text WebSocketFrame to this WebSocket.
default void	write(String text, boolean finalFragment)	Writes a text WebSocketFrame to this WebSocket whose WebSocketFrame.isFinalFragment() is set to finalFragment.
default void	writePing()	Writes a ping WebSocketFrame to this WebSocket.
default void	writePing(byte[] data)	Writes a ping WebSocketFrame to this WebSocket with the data.
default void	writePong()	Writes a pong WebSocketFrame to this WebSocket.
default void	writePong(byte[] data)	Writes a pong WebSocketFrame to this WebSocket with the data.

Methods inherited from interface com.linecorp.armeria.common.stream.StreamMessage

abort, abort, collect, collect, collect, decode, decode, defaultSubscriberExecutor, demand, endWith, filter, isComplete, isEmpty, map, mapAsync, mapError, mapParallel, mapParallel, peek, peek, peekError, recoverAndResume, recoverAndResume, subscribe, subscribe, subscribe, subscribe, subscribe, subscribe, toDuplicator, toDuplicator, toInputStream, toInputStream, whenComplete, writeTo

Methods inherited from interface com.linecorp.armeria.common.stream.StreamWriter

isOpen, tryWrite, tryWrite, whenConsumed, write, write

Method Details

write

default void write(String text)

Writes a text WebSocketFrame to this WebSocket.

See Also:

• WebSocketFrame.ofText(String)

write

default void write(String text,
 boolean finalFragment)

Writes a text WebSocketFrame to this WebSocket whose WebSocketFrame.isFinalFragment() is set to finalFragment.

See Also:

• WebSocketFrame.ofText(String, boolean)

write

default void write(byte[] data)

Writes a binary WebSocketFrame to this WebSocket.

See Also:

• WebSocketFrame.ofBinary(byte[])

write

default void write(byte[] data,
 boolean finalFragment)

Writes a binary WebSocketFrame to this WebSocket whose WebSocketFrame.isFinalFragment() is set to finalFragment.

See Also:

• WebSocketFrame.ofBinary(byte[], boolean)

tryWrite

default boolean tryWrite(String text)

Writes a text WebSocketFrame to this WebSocket.

Returns:

true if the text has been scheduled for publication. false if the writer has been closed already.

See Also:

• WebSocketFrame.ofText(String)

tryWrite

default boolean tryWrite(String text,
 boolean finalFragment)

Writes a text WebSocketFrame to this WebSocket.

Returns:

true if the text has been scheduled for publication. false if the writer has been closed already.

See Also:

• WebSocketFrame.ofText(String)

tryWrite

default boolean tryWrite(byte[] data)

Writes a binary WebSocketFrame to this WebSocket.

Returns:

true if the data has been scheduled for publication. false if the writer has been closed already.

See Also:

• WebSocketFrame.ofBinary(byte[])

tryWrite

default boolean tryWrite(byte[] data,
 boolean finalFragment)

Writes a binary WebSocketFrame to this WebSocket.

Returns:

true if the data has been scheduled for publication. false if the writer has been closed already.

See Also:

• WebSocketFrame.ofBinary(byte[])

writePing

default void writePing()

Writes a ping WebSocketFrame to this WebSocket.

See Also:

• WebSocketFrame.ofPing()

writePing

default void writePing(byte[] data)

Writes a ping WebSocketFrame to this WebSocket with the data.

See Also:

• WebSocketFrame.ofPing(byte[])

writePong

default void writePong()

Writes a pong WebSocketFrame to this WebSocket.

See Also:

• WebSocketFrame.ofPong()

writePong

default void writePong(byte[] data)

Writes a pong WebSocketFrame to this WebSocket with the data.

See Also:

• WebSocketFrame.ofPong(byte[])

close

void close()

Sends the closing handshake with WebSocketCloseStatus.NORMAL_CLOSURE.

Specified by:

close in interface StreamWriter<WebSocketFrame>

close

void close(WebSocketCloseStatus status)

Sends the closing handshake with the WebSocketCloseStatus.

close

void close(WebSocketCloseStatus status,
 String reasonPhrase)

Sends the closing handshake with the WebSocketCloseStatus and the reason.

close

void close(Throwable cause)

Sends the closing handshake with the WebSocketCloseStatus.INTERNAL_SERVER_ERROR and Throwable.getMessage().

Specified by:

close in interface StreamWriter<WebSocketFrame>