org.springframework.web.reactive.socket.adapter

Class RxNettyWebSocketSession

java.lang.Object

org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession<T>

org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport<WebSocketConnection>

org.springframework.web.reactive.socket.adapter.RxNettyWebSocketSession

All Implemented Interfaces:

WebSocketSession

public class RxNettyWebSocketSession
extends NettyWebSocketSessionSupport<WebSocketConnection>

Spring WebSocketSession implementation that adapts to the RxNetty io.reactivex.netty.protocol.http.ws.WebSocketConnection.

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FRAME_AGGREGATOR_NAME The ChannelHandler name to use when inserting a WebSocketFrameAggregator in the channel pipeline.

Fields inherited from class org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport

DEFAULT_FRAME_MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
RxNettyWebSocketSession(WebSocketConnection conn, HandshakeInfo info, NettyDataBufferFactory factory)

Method Summary

Modifier and Type	Method and Description
RxNettyWebSocketSession	aggregateFrames(Channel channel, java.lang.String frameDecoderName) Insert an WebSocketFrameAggregator after the WebSocketFrameDecoder for receiving full messages.
<any>	close(CloseStatus status) Close the WebSocket session with the given status.
<any>	receive() Get the flux of incoming messages.
<any>	send(<any> messages) Write the given messages to the WebSocket connection.

Methods inherited from class org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport

bufferFactory, toFrame, toMessage

Methods inherited from class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession

binaryMessage, getDelegate, getHandshakeInfo, getId, pingMessage, pongMessage, textMessage, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.web.reactive.socket.WebSocketSession

close

Field Detail

FRAME_AGGREGATOR_NAME

public static final java.lang.String FRAME_AGGREGATOR_NAME

The ChannelHandler name to use when inserting a WebSocketFrameAggregator in the channel pipeline.

See Also:

Constant Field Values

Constructor Detail

RxNettyWebSocketSession

public RxNettyWebSocketSession(WebSocketConnection conn,
                               HandshakeInfo info,
                               NettyDataBufferFactory factory)

Method Detail

aggregateFrames

public RxNettyWebSocketSession aggregateFrames(Channel channel,
                                               java.lang.String frameDecoderName)

Insert an WebSocketFrameAggregator after the WebSocketFrameDecoder for receiving full messages.

Parameters:

channel - the channel for the session

frameDecoderName - the name of the WebSocketFrame decoder

receive

public <any> receive()

Description copied from interface: WebSocketSession

Get the flux of incoming messages.

Specified by:

receive in interface WebSocketSession

Overrides:

receive in class AbstractWebSocketSession<WebSocketConnection>

send

public <any> send(<any> messages)

Description copied from interface: WebSocketSession

Write the given messages to the WebSocket connection.

Specified by:

send in interface WebSocketSession

Overrides:

send in class AbstractWebSocketSession<WebSocketConnection>

Parameters:

messages - the messages to write

close

public <any> close(CloseStatus status)

Description copied from interface: WebSocketSession

Close the WebSocket session with the given status.

Parameters:

status - the close status