spring-framework / org.springframework.web.reactive.socket.adapter / AbstractWebSocketSession

AbstractWebSocketSession

abstract class AbstractWebSocketSession<T : Any> : WebSocketSession

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

Author
Rossen Stoyanchev

Since
5.0

Functions

binaryMessage

open fun binaryMessage(payloadFactory: Function<DataBufferFactory, DataBuffer>): WebSocketMessage

bufferFactory

open fun bufferFactory(): DataBufferFactory

getHandshakeInfo

open fun getHandshakeInfo(): HandshakeInfo

getId

open fun getId(): String

pingMessage

open fun pingMessage(payloadFactory: Function<DataBufferFactory, DataBuffer>): WebSocketMessage

pongMessage

open fun pongMessage(payloadFactory: Function<DataBufferFactory, DataBuffer>): WebSocketMessage

receive

abstract fun receive(): Flux<WebSocketMessage>

send

abstract fun send(messages: Publisher<WebSocketMessage>): Mono<Void>

textMessage

open fun textMessage(payload: String): WebSocketMessage

toString

open fun toString(): String

Inheritors

NettyWebSocketSessionSupport

abstract class NettyWebSocketSessionSupport<T : Any> : AbstractWebSocketSession<T>

Base class for Netty-based WebSocketSession adapters that provides convenience methods to convert Netty WebSocketFrames to and from WebSocketMessages.