public class StandardWebSocketSession extends AbstractListenerWebSocketSession<Session>
WebSocketSession
adapter for a standard Java (JSR 356)
javax.websocket.Session
.Modifier and Type | Class and Description |
---|---|
private class |
StandardWebSocketSession.SendProcessorCallback |
AbstractListenerWebSocketSession.WebSocketSendProcessor
Constructor and Description |
---|
StandardWebSocketSession(Session session,
HandshakeInfo info,
DataBufferFactory factory) |
StandardWebSocketSession(Session session,
HandshakeInfo info,
DataBufferFactory factory,
<any> completionMono) |
Modifier and Type | Method and Description |
---|---|
protected boolean |
canSuspendReceiving()
Whether the underlying WebSocket API has flow control and can suspend and
resume the receiving of messages.
|
<any> |
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.
|
getSendProcessor, handleClose, handleError, handleMessage, onComplete, onError, onNext, onSubscribe, receive, send
binaryMessage, bufferFactory, getDelegate, getHandshakeInfo, getId, pingMessage, pongMessage, textMessage, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
close
public StandardWebSocketSession(Session session, HandshakeInfo info, DataBufferFactory factory)
public StandardWebSocketSession(Session session, HandshakeInfo info, DataBufferFactory factory, @Nullable <any> completionMono)
protected boolean canSuspendReceiving()
AbstractListenerWebSocketSession
Note: Sub-classes are encouraged to start out in suspended mode, if possible, and wait until demand is received.
canSuspendReceiving
in class AbstractListenerWebSocketSession<Session>
protected void suspendReceiving()
AbstractListenerWebSocketSession
Note: if the underlying WebSocket API does not provide
flow control for receiving messages, and this method should be a no-op
and AbstractListenerWebSocketSession.canSuspendReceiving()
should return false
.
suspendReceiving
in class AbstractListenerWebSocketSession<Session>
protected void resumeReceiving()
AbstractListenerWebSocketSession
Note: if the underlying WebSocket API does not provide
flow control for receiving messages, and this method should be a no-op
and AbstractListenerWebSocketSession.canSuspendReceiving()
should return false
.
resumeReceiving
in class AbstractListenerWebSocketSession<Session>
protected boolean sendMessage(WebSocketMessage message) throws java.io.IOException
AbstractListenerWebSocketSession
Note: Sub-classes are responsible for releasing the payload data buffer, once fully written, if pooled buffers apply to the underlying container.
sendMessage
in class AbstractListenerWebSocketSession<Session>
java.io.IOException
public <any> close(CloseStatus status)
WebSocketSession
status
- the close status