org.springframework.web.reactive.socket

Interface WebSocketSession

All Known Implementing Classes:

AbstractListenerWebSocketSession, AbstractWebSocketSession, JettyWebSocketSession, NettyWebSocketSessionSupport, ReactorNettyWebSocketSession, StandardWebSocketSession, TomcatWebSocketSession, UndertowWebSocketSession

public interface WebSocketSession

Represents a WebSocket session with Reactive Streams input and output.

On the server side a WebSocket session can be handled by mapping requests to a WebSocketHandler and ensuring there is a WebSocketHandlerAdapter strategy registered in Spring configuration. On the client side a WebSocketHandler can be provided to a WebSocketClient.

Since:

5.0

Author:

Rossen Stoyanchev

Method Summary

Modifier and Type	Method and Description
WebSocketMessage	binaryMessage(Function<DataBufferFactory,DataBuffer> payloadFactory) Factory method to create a binary WebSocketMessage using the bufferFactory() for the session.
DataBufferFactory	bufferFactory() Return a DataBuffer Factory to create message payloads.
default reactor.core.publisher.Mono<Void>	close() Close the WebSocket session with CloseStatus.NORMAL.
reactor.core.publisher.Mono<Void>	close(CloseStatus status) Close the WebSocket session with the given status.
HandshakeInfo	getHandshakeInfo() Return information from the handshake request.
String	getId() Return the id for the session.
WebSocketMessage	pingMessage(Function<DataBufferFactory,DataBuffer> payloadFactory) Factory method to create a ping WebSocketMessage using the bufferFactory() for the session.
WebSocketMessage	pongMessage(Function<DataBufferFactory,DataBuffer> payloadFactory) Factory method to create a pong WebSocketMessage using the bufferFactory() for the session.
reactor.core.publisher.Flux<WebSocketMessage>	receive() Get the flux of incoming messages.
reactor.core.publisher.Mono<Void>	send(org.reactivestreams.Publisher<WebSocketMessage> messages) Write the given messages to the WebSocket connection.
WebSocketMessage	textMessage(String payload) Factory method to create a text WebSocketMessage using the bufferFactory() for the session.

Method Detail

getId

String getId()

Return the id for the session.

getHandshakeInfo

HandshakeInfo getHandshakeInfo()

Return information from the handshake request.

bufferFactory

DataBufferFactory bufferFactory()

Return a DataBuffer Factory to create message payloads.

Returns:

the buffer factory for the session

receive

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

Get the flux of incoming messages.

send

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

Write the given messages to the WebSocket connection.

Parameters:

messages - the messages to write

close

default reactor.core.publisher.Mono<Void> close()

Close the WebSocket session with CloseStatus.NORMAL.

close

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

Close the WebSocket session with the given status.

Parameters:

status - the close status

textMessage

WebSocketMessage textMessage(String payload)

Factory method to create a text WebSocketMessage using the bufferFactory() for the session.

binaryMessage

WebSocketMessage binaryMessage(Function<DataBufferFactory,DataBuffer> payloadFactory)

Factory method to create a binary WebSocketMessage using the bufferFactory() for the session.

pingMessage

WebSocketMessage pingMessage(Function<DataBufferFactory,DataBuffer> payloadFactory)

Factory method to create a ping WebSocketMessage using the bufferFactory() for the session.

pongMessage

WebSocketMessage pongMessage(Function<DataBufferFactory,DataBuffer> payloadFactory)

Factory method to create a pong WebSocketMessage using the bufferFactory() for the session.