Package reactor.netty.http.websocket

Interface WebsocketOutbound

All Superinterfaces:

NettyOutbound, Publisher<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	Description
static final Function<? super ByteBuf,? extends WebSocketFrame>	bytebufToWebsocketFrame
static final Function<? super String,? extends WebSocketFrame>	stringToWebsocketFrame

Method Summary

Modifier and Type	Method	Description
@Nullable String	selectedSubprotocol()	Returns the websocket subprotocol negotiated by the client and server during the websocket handshake, or null if none was requested.
NettyOutbound	send(Publisher<? extends ByteBuf> dataStream)
Mono<Void>	sendClose()	Prepare to send a close frame on subscribe then close the underlying channel.
Mono<Void>	sendClose(int rsv)	Prepare to send a close frame on subscribe then close the underlying channel.
Mono<Void>	sendClose(int rsv, int statusCode, @Nullable String reasonText)	Prepare to send a close frame on subscribe then close the underlying channel.
Mono<Void>	sendClose(int statusCode, @Nullable String reasonText)	Prepare to send a close frame on subscribe then close the underlying channel.
default NettyOutbound	sendString(Publisher<? extends String> dataStream, Charset charset)

Methods inherited from interface reactor.netty.NettyOutbound

alloc, neverComplete, send, sendByteArray, sendFile, sendFile, sendFileChunked, sendGroups, sendObject, sendObject, sendObject, sendString, sendUsing, subscribe, then, then, then, withConnection

Field Details

stringToWebsocketFrame

static final Function<? super String,? extends WebSocketFrame> stringToWebsocketFrame

bytebufToWebsocketFrame

static final Function<? super ByteBuf,? extends WebSocketFrame> bytebufToWebsocketFrame

Method Details

selectedSubprotocol

@Nullable 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

NettyOutbound send(Publisher<? extends ByteBuf> dataStream)

Specified by:

send in interface NettyOutbound

sendClose

Mono<Void> sendClose()

Prepare to send a close frame on subscribe then close the underlying channel.

Returns:

a Mono fulfilled when the send succeeded or failed, immediately completed if already closed

sendClose

Mono<Void> sendClose(int rsv)

Prepare to send a close frame on subscribe then close the underlying channel.

Parameters:

rsv - reserved bits used for protocol extensions

Returns:

a Mono fulfilled when the send succeeded or failed, immediately completed if already closed

sendClose

Mono<Void> sendClose(int statusCode,
 @Nullable String reasonText)

Prepare to send a close frame on subscribe then close the underlying channel.

Parameters:

statusCode - Integer status code as per RFC 6455#section-7.4. For example, 1000 indicates normal closure.

reasonText - Reason text. Set to null if no text.

Returns:

a Mono fulfilled when the send succeeded or failed, immediately completed if already closed

Throws:

IllegalArgumentException - when the status code MUST NOT be set as a status code in a Close control frame. Consider checking RFC 6455#section-7.4 for a complete list of the close status codes.

sendClose

Mono<Void> sendClose(int rsv,
 int statusCode,
 @Nullable String reasonText)

Prepare to send a close frame on subscribe then close the underlying channel.

Parameters:

rsv - reserved bits used for protocol extensions

statusCode - Integer status code as per RFC 6455#section-7.4. For example, 1000 indicates normal closure.

reasonText - Reason text. Set to null if no text.

Returns:

a Mono fulfilled when the send succeeded or failed, immediately completed if already closed

Throws:

IllegalArgumentException - when the status code MUST NOT be set as a status code in a Close control frame. Consider checking RFC 6455#section-7.4 for a complete list of the close status codes.

sendString

default NettyOutbound sendString(Publisher<? extends String> dataStream,
 Charset charset)

Specified by:

sendString in interface NettyOutbound