org.springframework.web.reactive.socket.adapter

Class ReactorNettyWebSocketSession

java.lang.Object

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

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

org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession

All Implemented Interfaces:

WebSocketSession

public class ReactorNettyWebSocketSession
extends NettyWebSocketSessionSupport<ReactorNettyWebSocketSession.WebSocketConnection>

Spring WebSocketSession implementation that adapts to Reactor Netty's WebSocket NettyInbound and NettyOutbound.

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReactorNettyWebSocketSession.WebSocketConnection Simple container for NettyInbound and NettyOutbound.

Field Summary

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

DEFAULT_FRAME_MAX_SIZE

Constructor Summary

Constructors

Constructor and Description
ReactorNettyWebSocketSession(reactor.ipc.netty.http.websocket.WebsocketInbound inbound, reactor.ipc.netty.http.websocket.WebsocketOutbound outbound, HandshakeInfo info, org.springframework.core.io.buffer.NettyDataBufferFactory bufferFactory)

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<java.lang.Void>	close(CloseStatus status) Close the WebSocket session with the given status.
reactor.core.publisher.Flux<WebSocketMessage>	receive() Get the flux of incoming messages.
reactor.core.publisher.Mono<java.lang.Void>	send(org.reactivestreams.Publisher<WebSocketMessage> 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

Constructor Detail

ReactorNettyWebSocketSession

public ReactorNettyWebSocketSession(reactor.ipc.netty.http.websocket.WebsocketInbound inbound,
                                    reactor.ipc.netty.http.websocket.WebsocketOutbound outbound,
                                    HandshakeInfo info,
                                    org.springframework.core.io.buffer.NettyDataBufferFactory bufferFactory)

Method Detail

receive

public reactor.core.publisher.Flux<WebSocketMessage> receive()

Description copied from interface: WebSocketSession

Get the flux of incoming messages.

Specified by:

receive in interface WebSocketSession

Specified by:

receive in class AbstractWebSocketSession<ReactorNettyWebSocketSession.WebSocketConnection>

send

public reactor.core.publisher.Mono<java.lang.Void> send(org.reactivestreams.Publisher<WebSocketMessage> messages)

Description copied from interface: WebSocketSession

Write the given messages to the WebSocket connection.

Specified by:

send in interface WebSocketSession

Specified by:

send in class AbstractWebSocketSession<ReactorNettyWebSocketSession.WebSocketConnection>

Parameters:

messages - the messages to write

close

public reactor.core.publisher.Mono<java.lang.Void> close(CloseStatus status)

Description copied from interface: WebSocketSession

Close the WebSocket session with the given status.

Parameters:

status - the close status