Package com.linecorp.armeria.common.websocket

Interface WebSocket

All Superinterfaces:

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

All Known Subinterfaces:

WebSocketWriter

@UnstableApi
public interface WebSocket
extends StreamMessage<WebSocketFrame>

A StreamMessage that publishes WebSocketFrames.

Method Summary

Static Methods

Modifier and Type	Method	Description
static WebSocket	of(StreamMessage<WebSocketFrame> delegate)	Returns a new WebSocket whose stream is produced from the specified StreamMessage.
static WebSocketWriter	streaming()	Returns a new WebSocketWriter that you can write WebSocketFrames to send to the peer.

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

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

Method Details

streaming

static WebSocketWriter streaming()

Returns a new WebSocketWriter that you can write WebSocketFrames to send to the peer.

of

@UnstableApi
static WebSocket of(StreamMessage<WebSocketFrame> delegate)

Returns a new WebSocket whose stream is produced from the specified StreamMessage.