Module io.inverno.mod.http.base

Package io.inverno.mod.http.base.internal.ws

Class GenericWebSocketMessage

java.lang.Object

io.inverno.mod.http.base.internal.ws.GenericWebSocketMessage

All Implemented Interfaces:

WebSocketMessage

public class GenericWebSocketMessage
extends Object
implements WebSocketMessage

Generic WebSocketMessage implementation.

Since:

1.5

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GenericWebSocketMessage.GenericFactory	Generic WebSocketMessage.Factory implementation.

Nested classes/interfaces inherited from interface io.inverno.mod.http.base.ws.WebSocketMessage

WebSocketMessage.Factory, WebSocketMessage.Kind

Constructor Summary

Constructors

Constructor	Description
GenericWebSocketMessage(WebSocketMessage.Kind kind, org.reactivestreams.Publisher<WebSocketFrame> frames)	Creates a generic WebSocket message.

Method Summary

Modifier and Type	Method	Description
org.reactivestreams.Publisher<io.netty.buffer.ByteBuf>	binary()	Returns the message payload binary data stream.
org.reactivestreams.Publisher<WebSocketFrame>	frames()	Returns the frames that composes the message.
WebSocketMessage.Kind	getKind()	Returns the WebSocket message type.
reactor.core.publisher.Mono<io.netty.buffer.ByteBuf>	reducedBinary()	Returns the message payload binary data.
reactor.core.publisher.Mono<String>	reducedText()	Returns the message payload text data stream.
org.reactivestreams.Publisher<String>	text()	Returns the message payload text data stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GenericWebSocketMessage

public GenericWebSocketMessage(WebSocketMessage.Kind kind,
 org.reactivestreams.Publisher<WebSocketFrame> frames)

Creates a generic WebSocket message.

Parameters:

kind - the message type

frames - the frames that composes the message

Method Details

getKind

public WebSocketMessage.Kind getKind()

Description copied from interface: WebSocketMessage

Returns the WebSocket message type.

Specified by:

getKind in interface WebSocketMessage

Returns:

a WebSocket message type

frames

public org.reactivestreams.Publisher<WebSocketFrame> frames()

Description copied from interface: WebSocketMessage

Returns the frames that composes the message.

Note that the returned publisher is exclusive: it is only possible to subscribe to one of the publisher returned by WebSocketMessage.frames(), WebSocketMessage.binary(), WebSocketMessage.reducedBinary(), WebSocketMessage.text() or WebSocketMessage.reducedText().

Specified by:

frames in interface WebSocketMessage

Returns:

a WebSocker frames publisher

binary

public org.reactivestreams.Publisher<io.netty.buffer.ByteBuf> binary()

Description copied from interface: WebSocketMessage

Returns the message payload binary data stream.

Note that the returned publisher is exclusive: it is only possible to subscribe to one of the publisher returned by WebSocketMessage.frames(), WebSocketMessage.binary(), WebSocketMessage.reducedBinary(), WebSocketMessage.text() or WebSocketMessage.reducedText().

Specified by:

binary in interface WebSocketMessage

Returns:

a data publisher

reducedBinary

public reactor.core.publisher.Mono<io.netty.buffer.ByteBuf> reducedBinary()

Description copied from interface: WebSocketMessage

Returns the message payload binary data.

This method basically reduces the result of WebSocketMessage.binary().

Note that the returned publisher is exclusive: it is only possible to subscribe to one of the publisher returned by WebSocketMessage.frames(), WebSocketMessage.binary(), WebSocketMessage.reducedBinary(), WebSocketMessage.text() or WebSocketMessage.reducedText().

Specified by:

reducedBinary in interface WebSocketMessage

Returns:

a mono emitting the binary payload

text

public org.reactivestreams.Publisher<String> text()

Description copied from interface: WebSocketMessage

Returns the message payload text data stream.

Note that the returned publisher is exclusive: it is only possible to subscribe to one of the publisher returned by WebSocketMessage.frames(), WebSocketMessage.binary(), WebSocketMessage.reducedBinary(), WebSocketMessage.text() or WebSocketMessage.reducedText().

Specified by:

text in interface WebSocketMessage

Returns:

a text publisher

reducedText

public reactor.core.publisher.Mono<String> reducedText()

Description copied from interface: WebSocketMessage

Returns the message payload text data stream.

This method basically reduces the result of WebSocketMessage.text().

Note that the returned publisher is exclusive: it is only possible to subscribe to one of the publisher returned by WebSocketMessage.frames(), WebSocketMessage.binary(), WebSocketMessage.reducedBinary(), WebSocketMessage.text() or WebSocketMessage.reducedText().

Specified by:

reducedText in interface WebSocketMessage

Returns:

a mono emitting the text payload