Class JettyWebSocketSession
- java.lang.Object
- org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession<T>
- org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession<org.eclipse.jetty.websocket.api.Session>
- org.springframework.web.reactive.socket.adapter.JettyWebSocketSession
- All Implemented Interfaces:
org.reactivestreams.Subscriber<Void>
,WebSocketSession
public class JettyWebSocketSession extends AbstractListenerWebSocketSession<org.eclipse.jetty.websocket.api.Session>
SpringWebSocketSession
implementation that adapts to a Jetty WebSocketSession
.- Since:
- 5.0
- Author:
- Violeta Georgieva, Rossen Stoyanchev
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
AbstractListenerWebSocketSession.WebSocketSendProcessor
Field Summary
Fields inherited from class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
logger
Constructor Summary
Constructors Constructor Description JettyWebSocketSession(org.eclipse.jetty.websocket.api.Session session, HandshakeInfo info, DataBufferFactory factory)
JettyWebSocketSession(org.eclipse.jetty.websocket.api.Session session, HandshakeInfo info, DataBufferFactory factory, reactor.core.publisher.MonoProcessor<Void> completionMono)
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canSuspendReceiving()
Whether the underlying WebSocket API has flow control and can suspend and resume the receiving of messages.reactor.core.publisher.Mono<Void>
close(CloseStatus status)
Close the WebSocket session with the given status.protected void
resumeReceiving()
Resume receiving new message(s) after demand is generated by the downstream Subscriber.protected boolean
sendMessage(WebSocketMessage message)
Send the given WebSocket message.protected void
suspendReceiving()
Suspend receiving until received message(s) are processed and more demand is generated by the downstream Subscriber.Methods inherited from class org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession
getSendProcessor, onComplete, onError, onNext, onSubscribe, receive, send
Methods inherited from class org.springframework.web.reactive.socket.adapter.AbstractWebSocketSession
binaryMessage, bufferFactory, getAttributes, getDelegate, getHandshakeInfo, getId, getLogPrefix, pingMessage, pongMessage, 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
Constructor Detail
JettyWebSocketSession
public JettyWebSocketSession(org.eclipse.jetty.websocket.api.Session session, HandshakeInfo info, DataBufferFactory factory)
JettyWebSocketSession
public JettyWebSocketSession(org.eclipse.jetty.websocket.api.Session session, HandshakeInfo info, DataBufferFactory factory, @Nullable reactor.core.publisher.MonoProcessor<Void> completionMono)
Method Detail
canSuspendReceiving
protected boolean canSuspendReceiving()
Description copied from class:AbstractListenerWebSocketSession
Whether the underlying WebSocket API has flow control and can suspend and resume the receiving of messages.Note: Sub-classes are encouraged to start out in suspended mode, if possible, and wait until demand is received.
- Specified by:
canSuspendReceiving
in classAbstractListenerWebSocketSession<org.eclipse.jetty.websocket.api.Session>
suspendReceiving
protected void suspendReceiving()
Description copied from class:AbstractListenerWebSocketSession
Suspend receiving until received message(s) are processed and more demand is generated by the downstream Subscriber.Note: if the underlying WebSocket API does not provide flow control for receiving messages, this method should be a no-op and
AbstractListenerWebSocketSession.canSuspendReceiving()
should returnfalse
.- Specified by:
suspendReceiving
in classAbstractListenerWebSocketSession<org.eclipse.jetty.websocket.api.Session>
resumeReceiving
protected void resumeReceiving()
Description copied from class:AbstractListenerWebSocketSession
Resume receiving new message(s) after demand is generated by the downstream Subscriber.Note: if the underlying WebSocket API does not provide flow control for receiving messages, this method should be a no-op and
AbstractListenerWebSocketSession.canSuspendReceiving()
should returnfalse
.- Specified by:
resumeReceiving
in classAbstractListenerWebSocketSession<org.eclipse.jetty.websocket.api.Session>
sendMessage
protected boolean sendMessage(WebSocketMessage message) throws IOException
Description copied from class:AbstractListenerWebSocketSession
Send the given WebSocket message.Note: Sub-classes are responsible for releasing the payload data buffer, once fully written, if pooled buffers apply to the underlying container.
- Specified by:
sendMessage
in classAbstractListenerWebSocketSession<org.eclipse.jetty.websocket.api.Session>
- Throws:
IOException
close
public reactor.core.publisher.Mono<Void> close(CloseStatus status)
Description copied from interface:WebSocketSession
Close the WebSocket session with the given status.- Parameters:
status
- the close status