org.springframework.web.reactive.socket.adapter

Class AbstractWebSocketSession<T>

java.lang.Object

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

All Implemented Interfaces:

WebSocketSession

Direct Known Subclasses:

AbstractListenerWebSocketSession, NettyWebSocketSessionSupport

public abstract class AbstractWebSocketSession<T>
extends java.lang.Object
implements WebSocketSession

Convenient base class for WebSocketSession implementations that holds common fields and exposes accessors. Also implements the WebSocketMessage factory methods.

Since:

5.0

Author:

Rossen Stoyanchev

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractWebSocketSession(T delegate, java.lang.String id, HandshakeInfo handshakeInfo, DataBufferFactory bufferFactory) Create a new instance and associate the given attributes with it.

Method Summary

Modifier and Type	Method and Description
WebSocketMessage	binaryMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory) Factory method to create a binary WebSocketMessage using the WebSocketSession.bufferFactory() for the session.
DataBufferFactory	bufferFactory() Return a DataBuffer Factory to create message payloads.
protected T	getDelegate()
HandshakeInfo	getHandshakeInfo() Return information from the handshake request.
java.lang.String	getId() Return the id for the session.
WebSocketMessage	pingMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory) Factory method to create a ping WebSocketMessage using the WebSocketSession.bufferFactory() for the session.
WebSocketMessage	pongMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory) Factory method to create a pong WebSocketMessage using the WebSocketSession.bufferFactory() for the session.
abstract reactor.core.publisher.Flux<WebSocketMessage>	receive() Provides access to the stream of inbound messages.
abstract reactor.core.publisher.Mono<java.lang.Void>	send(org.reactivestreams.Publisher<WebSocketMessage> messages) Give a source of outgoing messages, write the messages and return a Mono<Void> that completes when the source completes and writing is done.
WebSocketMessage	textMessage(java.lang.String payload) Factory method to create a text WebSocketMessage using the WebSocketSession.bufferFactory() for the session.
java.lang.String	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, close

Constructor Detail

AbstractWebSocketSession

protected AbstractWebSocketSession(T delegate,
                                   java.lang.String id,
                                   HandshakeInfo handshakeInfo,
                                   DataBufferFactory bufferFactory)

Create a new instance and associate the given attributes with it.

Method Detail

getDelegate

protected T getDelegate()

getId

public java.lang.String getId()

Description copied from interface: WebSocketSession

Return the id for the session.

Specified by:

getId in interface WebSocketSession

getHandshakeInfo

public HandshakeInfo getHandshakeInfo()

Description copied from interface: WebSocketSession

Return information from the handshake request.

Specified by:

getHandshakeInfo in interface WebSocketSession

bufferFactory

public DataBufferFactory bufferFactory()

Description copied from interface: WebSocketSession

Return a DataBuffer Factory to create message payloads.

Specified by:

bufferFactory in interface WebSocketSession

Returns:

the buffer factory for the session

receive

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

Description copied from interface: WebSocketSession

Provides access to the stream of inbound messages.

This stream receives a completion or error signal when the connection is closed. In a typical WebSocketHandler implementation this stream is composed into the overall processing flow, so that when the connection is closed, handling will end.

See the class-level doc of WebSocketHandler and the reference for more details and examples of how to handle the session.

Specified by:

receive in interface WebSocketSession

send

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

Description copied from interface: WebSocketSession

Give a source of outgoing messages, write the messages and return a Mono<Void> that completes when the source completes and writing is done.

See the class-level doc of WebSocketHandler and the reference for more details and examples of how to handle the session.

Specified by:

send in interface WebSocketSession

textMessage

public WebSocketMessage textMessage(java.lang.String payload)

Description copied from interface: WebSocketSession

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

Specified by:

textMessage in interface WebSocketSession

binaryMessage

public WebSocketMessage binaryMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory)

Description copied from interface: WebSocketSession

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

Specified by:

binaryMessage in interface WebSocketSession

pingMessage

public WebSocketMessage pingMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory)

Description copied from interface: WebSocketSession

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

Specified by:

pingMessage in interface WebSocketSession

pongMessage

public WebSocketMessage pongMessage(java.util.function.Function<DataBufferFactory,DataBuffer> payloadFactory)

Description copied from interface: WebSocketSession

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

Specified by:

pongMessage in interface WebSocketSession

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object