Package org.springframework.web.reactive.socket.adapter

Class NettyWebSocketSessionSupport<T>

java.lang.Object

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

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

Type Parameters:

T - the native delegate type

All Implemented Interfaces:

WebSocketSession

Direct Known Subclasses:

ReactorNettyWebSocketSession

public abstract class NettyWebSocketSessionSupport<T>
extends AbstractWebSocketSession<T>

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

Since:

5.0

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_FRAME_MAX_SIZE	The default max size for inbound WebSocket frames.

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

logger

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	NettyWebSocketSessionSupport(T delegate, String id, HandshakeInfo info, NettyDataBufferFactory factory)	Variant of NettyWebSocketSessionSupport(Object, HandshakeInfo, NettyDataBufferFactory) with a given WebSocket session id.
protected	NettyWebSocketSessionSupport(T delegate, HandshakeInfo info, NettyDataBufferFactory factory)	Constructor that uses the hashcode of the delegate as the session id.

Method Summary

Modifier and Type	Method	Description
NettyDataBufferFactory	bufferFactory()	Return a DataBuffer Factory to create message payloads.
protected io.netty.handler.codec.http.websocketx.WebSocketFrame	toFrame(WebSocketMessage message)
protected WebSocketMessage	toMessage(io.netty.handler.codec.http.websocketx.WebSocketFrame frame)

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

binaryMessage, getAttributes, getDelegate, getHandshakeInfo, getId, getLogPrefix, pingMessage, pongMessage, receive, send, 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, close, closeStatus, isOpen

Field Details

DEFAULT_FRAME_MAX_SIZE

public static final int DEFAULT_FRAME_MAX_SIZE

The default max size for inbound WebSocket frames.

See Also:

• Constant Field Values

Constructor Details

NettyWebSocketSessionSupport

protected NettyWebSocketSessionSupport(T delegate,
 HandshakeInfo info,
 NettyDataBufferFactory factory)

Constructor that uses the hashcode of the delegate as the session id.

NettyWebSocketSessionSupport

protected NettyWebSocketSessionSupport(T delegate,
 String id,
 HandshakeInfo info,
 NettyDataBufferFactory factory)

Variant of NettyWebSocketSessionSupport(Object, HandshakeInfo, NettyDataBufferFactory) with a given WebSocket session id.

Since:

6.2.15

Method Details

bufferFactory

public NettyDataBufferFactory bufferFactory()

Description copied from interface: WebSocketSession

Return a DataBuffer Factory to create message payloads.

Specified by:

bufferFactory in interface WebSocketSession

Overrides:

bufferFactory in class AbstractWebSocketSession<T>

Returns:

the buffer factory for the session

toMessage

protected WebSocketMessage toMessage(io.netty.handler.codec.http.websocketx.WebSocketFrame frame)

toFrame

protected io.netty.handler.codec.http.websocketx.WebSocketFrame toFrame(WebSocketMessage message)