public interface WebsocketOutbound extends NettyOutbound
| Modifier and Type | Field and Description |
|---|---|
static java.util.function.Function<? super ByteBuf,? extends WebSocketFrame> |
bytebufToWebsocketFrame |
static java.util.function.Function<? super String,? extends WebSocketFrame> |
stringToWebsocketFrame |
FILE_CHUNKED_STRATEGY_BUFFER| Modifier and Type | Method and Description |
|---|---|
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).
|
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,
String reasonText)
Prepare to send a close frame on subscribe then close the underlying channel
|
Mono<Void> |
sendClose(int statusCode,
String reasonText)
Prepare to send a close frame on subscribe then close the underlying channel
|
default NettyOutbound |
sendString(Publisher<? extends String> dataStream,
Charset charset)
Send String to the peer, listen for any error on write and close on terminal signal
(complete|error).
|
alloc, context, context, getFileChunkedStrategy, neverComplete, onWriteIdle, options, sendByteArray, sendFile, sendFile, sendFileChunked, sendGroups, sendObject, sendObject, sendString, subscribe, then, thenstatic final java.util.function.Function<? super String,? extends WebSocketFrame> stringToWebsocketFrame
static final java.util.function.Function<? super ByteBuf,? extends WebSocketFrame> bytebufToWebsocketFrame
String selectedSubprotocol()
Mono<Void> sendClose()
Mono fulfilled when the send succeeded or failed, immediately
completed if already closedMono<Void> sendClose(int rsv)
rsv - reserved bits used for protocol extensionsMono fulfilled when the send succeeded or failed, immediately
completed if already closedMono<Void> sendClose(int statusCode, String reasonText)
Mono<Void> sendClose(int rsv, int statusCode, String reasonText)
rsv - reserved bits used for protocol extensionsstatusCode - Integer status code as per RFC 6455. For
example, 1000 indicates normal closure.reasonText - Reason text. Set to null if no text.Mono fulfilled when the send succeeded or failed, immediately
completed if already closeddefault NettyOutbound send(Publisher<? extends ByteBuf> dataStream)
NettyOutboundA 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.
Note: Nesting any send* method is not supported.
send in interface NettyOutbounddataStream - the dataStream publishing OUT items to write on this channelNettyOutbound to append further send. It will emit a complete
signal successful sequence write (e.g. after "flush") or any error during write.default NettyOutbound sendString(Publisher<? extends String> dataStream, Charset charset)
NettyOutboundsendString in interface NettyOutbounddataStream - the dataStream publishing Buffer items to write on this channelcharset - the encoding charset