Modifier and Type	Class and Description
private static class	ReactorNettyWebSocketSession.DisposedCallback
public static class	ReactorNettyWebSocketSession.WebSocketConnection Simple container for `NettyInbound` and `NettyOutbound`.

Modifier and Type	Field and Description
private final ChannelId	channelId
private final int	maxFramePayloadLength

Access	Constructor and Description
public	ReactorNettyWebSocketSession(WebsocketInbound inbound, WebsocketOutbound outbound, HandshakeInfo info, NettyDataBufferFactory bufferFactory) Constructor for the session, using the `DEFAULT_FRAME_MAX_SIZE` value.
public	ReactorNettyWebSocketSession(WebsocketInbound inbound, WebsocketOutbound outbound, HandshakeInfo info, NettyDataBufferFactory bufferFactory, int maxFramePayloadLength) Constructor with an additional maxFramePayloadLength argument.

Method Summary

Modifier and Type	Method and Description
public Mono<Void>	close(CloseStatus the close status status) Implements org.springframework.web.reactive.socket.WebSocketSession.close. Close the WebSocket session with the given status.
public Mono<CloseStatus>	closeStatus() Implements org.springframework.web.reactive.socket.WebSocketSession.closeStatus. Provides access to the `CloseStatus` with which the session is closed either locally or remotely, or completes empty if the session ended without a status.
public ChannelId	getChannelId() Return the id of the underlying Netty channel.
public boolean	isOpen() Implements org.springframework.web.reactive.socket.WebSocketSession.isOpen. Whether the underlying connection is open.
public Flux<WebSocketMessage>	receive() Implements abstract org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession.receive. Implements org.springframework.web.reactive.socket.WebSocketSession.receive. Provides access to the stream of inbound messages.
public Mono<Void>	send(Publisher<WebSocketMessage> messages) Implements abstract org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession.send. Implements org.springframework.web.reactive.socket.WebSocketSession.send. Give a source of outgoing messages, write the messages and return a `Mono<Void>` that completes when the source completes and writing is done.

Inherited from org.springframework.web.reactive.socket.adapter.NettyWebSocketSessionSupport:: bufferFactory toFrame toMessage

Field Detail

channelId	back to summary
private final ChannelId channelId

maxFramePayloadLength	back to summary
private final int maxFramePayloadLength

Constructor Detail

ReactorNettyWebSocketSession	back to summary
public ReactorNettyWebSocketSession(WebsocketInbound inbound, WebsocketOutbound outbound, HandshakeInfo info, NettyDataBufferFactory bufferFactory) Constructor for the session, using the `DEFAULT_FRAME_MAX_SIZE` value.

ReactorNettyWebSocketSession	back to summary
public ReactorNettyWebSocketSession(WebsocketInbound inbound, WebsocketOutbound outbound, HandshakeInfo info, NettyDataBufferFactory bufferFactory, int maxFramePayloadLength) Constructor with an additional maxFramePayloadLength argument. Annotations @SuppressWarnings:rawtypes Since 5.1

ReactorNettyWebSocketSession

back to summary

public ReactorNettyWebSocketSession(WebsocketInbound inbound, WebsocketOutbound outbound, HandshakeInfo info, NettyDataBufferFactory bufferFactory, int maxFramePayloadLength)

Constructor with an additional maxFramePayloadLength argument.

Annotations

@SuppressWarnings:rawtypes

Since

5.1

Method Detail

close	back to summary
public Mono<Void> close(CloseStatus status) Implements org.springframework.web.reactive.socket.WebSocketSession.close. Doc from org.springframework.web.reactive.socket.WebSocketSession.close. Close the WebSocket session with the given status. Parameters status:CloseStatus the close status Annotations @Override

back to summary

public Mono<Void> close(CloseStatus status)

Implements org.springframework.web.reactive.socket.WebSocketSession.close.

Doc from org.springframework.web.reactive.socket.WebSocketSession.close.

Close the WebSocket session with the given status.

Parameters

status:CloseStatus: the close status

Annotations

@Override

closeStatus back to summary

closeStatus	back to summary
public Mono<CloseStatus> closeStatus() Implements org.springframework.web.reactive.socket.WebSocketSession.closeStatus. Doc from org.springframework.web.reactive.socket.WebSocketSession.closeStatus. Provides access to the `CloseStatus` with which the session is closed either locally or remotely, or completes empty if the session ended without a status. Annotations @Override

public Mono<CloseStatus> closeStatus()

Implements org.springframework.web.reactive.socket.WebSocketSession.closeStatus.

Doc from org.springframework.web.reactive.socket.WebSocketSession.closeStatus.

Provides access to the CloseStatus with which the session is closed either locally or remotely, or completes empty if the session ended without a status.

Annotations

@Override

getChannelId	back to summary
public ChannelId getChannelId() Return the id of the underlying Netty channel. Since 5.3.4

getChannelId

back to summary

public ChannelId getChannelId()

Return the id of the underlying Netty channel.

Since: 5.3.4

isOpen	back to summary
public boolean isOpen() Implements org.springframework.web.reactive.socket.WebSocketSession.isOpen. Doc from org.springframework.web.reactive.socket.WebSocketSession.isOpen. Whether the underlying connection is open. Annotations @Override

isOpen

back to summary

public boolean isOpen()

Implements org.springframework.web.reactive.socket.WebSocketSession.isOpen.

Doc from org.springframework.web.reactive.socket.WebSocketSession.isOpen.

Whether the underlying connection is open.

Annotations

@Override

receive back to summary

receive	back to summary
public Flux<WebSocketMessage> receive() Implements abstract org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession.receive. Implements org.springframework.web.reactive.socket.WebSocketSession.receive. Doc from org.springframework.web.reactive.socket.WebSocketSession.receive. 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. Annotations @Override

public Flux<WebSocketMessage> receive()

Implements abstract org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession.receive.

Implements org.springframework.web.reactive.socket.WebSocketSession.receive.

Doc from org.springframework.web.reactive.socket.WebSocketSession.receive.

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.

Annotations

@Override

send back to summary

send	back to summary
public Mono<Void> send(Publisher<WebSocketMessage> messages) Implements abstract org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession.send. Implements org.springframework.web.reactive.socket.WebSocketSession.send. Doc from org.springframework.web.reactive.socket.WebSocketSession.send. 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. Annotations @Override

public Mono<Void> send(Publisher<WebSocketMessage> messages)

Implements abstract org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession.send.

Implements org.springframework.web.reactive.socket.WebSocketSession.send.

Doc from org.springframework.web.reactive.socket.WebSocketSession.send.

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.

Annotations

@Override

org.springframework.web.reactive.socket.adapter back to summary

private Class ReactorNettyWebSocketSession.DisposedCallback

Class Inheritance

extends Object
implements Consumer<Connection>

java.lang.Object
org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession.DisposedCallback

All Implemented Interfaces

java.util.function.Consumer

Field Summary

Modifier and Type	Field and Description
private boolean	disposed

Constructor Summary

Access	Constructor and Description
private	DisposedCallback()

Method Summary

Modifier and Type	Method and Description
public void	accept(Connection the input argument connection) Implements java.util.function.Consumer.accept. Performs this operation on the given argument.
public boolean	isDisposed()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

disposed	back to summary
private boolean disposed

Constructor Detail

DisposedCallback	back to summary
private DisposedCallback()

Method Detail

accept	back to summary
public void accept(Connection connection) Implements java.util.function.Consumer.accept. Doc from java.util.function.Consumer.accept. Performs this operation on the given argument. Parameters connection:Connection the input argument Annotations @Override

back to summary

public void accept(Connection connection)

Implements java.util.function.Consumer.accept.

Doc from java.util.function.Consumer.accept.

Performs this operation on the given argument.

Parameters

connection:Connection: the input argument

Annotations

@Override

isDisposed	back to summary
public boolean isDisposed()

org.springframework.web.reactive.socket.adapter back to summary

public Class ReactorNettyWebSocketSession.WebSocketConnection

Class Inheritance

extends Object

java.lang.Object
org.springframework.web.reactive.socket.adapter.ReactorNettyWebSocketSession.WebSocketConnection

Simple container for NettyInbound and NettyOutbound.

Field Summary

Modifier and Type	Field and Description
private final WebsocketInbound	inbound
private final WebsocketOutbound	outbound

Constructor Summary

Access	Constructor and Description
public	WebSocketConnection(WebsocketInbound inbound, WebsocketOutbound outbound)

Method Summary

Modifier and Type	Method and Description
public WebsocketInbound	getInbound()
public WebsocketOutbound	getOutbound()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

inbound	back to summary
private final WebsocketInbound inbound

outbound	back to summary
private final WebsocketOutbound outbound

Constructor Detail

WebSocketConnection	back to summary
public WebSocketConnection(WebsocketInbound inbound, WebsocketOutbound outbound)

Method Detail

getInbound	back to summary
public WebsocketInbound getInbound()

getOutbound	back to summary
public WebsocketOutbound getOutbound()

public Class ReactorNettyWebSocketSession

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class ReactorNettyWebSocketSession.DisposedCallback

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class ReactorNettyWebSocketSession.WebSocketConnection

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail