reactor.ipc.netty.http.websocket

Interface WebsocketOutbound

All Superinterfaces:

NettyOutbound, Publisher<java.lang.Void>

public interface WebsocketOutbound
extends NettyOutbound

A websocket framed outbound

Since:

0.6

Author:

Stephane Maldini, Simon Baslé

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.function.Function<? super ByteBuf,? extends WebSocketFrame>	bytebufToWebsocketFrame
static java.util.function.Function<? super java.lang.String,? extends WebSocketFrame>	stringToWebsocketFrame

Fields inherited from interface reactor.ipc.netty.NettyOutbound

FILE_CHUNKED_STRATEGY_BUFFER

Method Summary

Modifier and Type	Method and Description
java.lang.String	selectedSubprotocol() Returns the websocket subprotocol negotiated by the client and server during the websocket handshake, or null if none was requested.
default NettyOutbound	send(Publisher<? extends ByteBuf> dataStream) Send data to the peer, listen for any error on write and close on terminal signal (complete|error).
default NettyOutbound	sendString(Publisher<? extends java.lang.String> dataStream, java.nio.charset.Charset charset) Send String to the peer, listen for any error on write and close on terminal signal (complete|error).

Methods inherited from interface reactor.ipc.netty.NettyOutbound

alloc, context, context, getFileChunkedStrategy, neverComplete, onWriteIdle, options, sendByteArray, sendFile, sendFile, sendFileChunked, sendGroups, sendObject, sendObject, sendString, subscribe, then, then

Field Detail

stringToWebsocketFrame

static final java.util.function.Function<? super java.lang.String,? extends WebSocketFrame> stringToWebsocketFrame

bytebufToWebsocketFrame

static final java.util.function.Function<? super ByteBuf,? extends WebSocketFrame> bytebufToWebsocketFrame

Method Detail

selectedSubprotocol

java.lang.String selectedSubprotocol()

Returns the websocket subprotocol negotiated by the client and server during the websocket handshake, or null if none was requested.

Returns:

the subprotocol, or null

send

default NettyOutbound send(Publisher<? extends ByteBuf> dataStream)

Description copied from interface: NettyOutbound

Send data to the peer, listen for any error on write and close on terminal signal (complete|error).

A new NettyOutbound type (or the same) for typed send sequences. An implementor can therefore specialize the Outbound after a first after a prepending data publisher.

Specified by:

send in interface NettyOutbound

Parameters:

dataStream - the dataStream publishing OUT items to write on this channel

Returns:

A new NettyOutbound to append further send. It will emit a complete signal successful sequence write (e.g. after "flush") or any error during write.

sendString

default NettyOutbound sendString(Publisher<? extends java.lang.String> dataStream,
                                 java.nio.charset.Charset charset)

Description copied from interface: NettyOutbound

Send String to the peer, listen for any error on write and close on terminal signal (complete|error). If more than one publisher is attached (multiple calls to send()) completion occurs after all publishers complete.

Specified by:

sendString in interface NettyOutbound

Parameters:

dataStream - the dataStream publishing Buffer items to write on this channel

charset - the encoding charset

Returns:

A Publisher to signal successful sequence write (e.g. after "flush") or any error during write