org.springframework.web.reactive.socket.adapter

Class AbstractListenerWebSocketSession.WebSocketReceivePublisher

java.lang.Object

org.springframework.http.server.reactive.AbstractListenerReadPublisher<WebSocketMessage>

org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession.WebSocketReceivePublisher

Enclosing class:

AbstractListenerWebSocketSession<T>

private final class AbstractListenerWebSocketSession.WebSocketReceivePublisher
extends AbstractListenerReadPublisher<WebSocketMessage>

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Queue<java.lang.Object>	pendingMessages

Fields inherited from class org.springframework.http.server.reactive.AbstractListenerReadPublisher

rsReadLogger

Constructor Summary

Constructors

Constructor and Description
WebSocketReceivePublisher()

Method Summary

Modifier and Type	Method and Description
protected void	checkOnDataAvailable() Check if data is available and either call AbstractListenerReadPublisher.onDataAvailable() immediately or schedule a notification.
protected void	discardData() Invoked after an I/O read error from the underlying server or after a cancellation signal from the downstream consumer to allow sub-classes to discard any current cached data they might have.
(package private) void	handleMessage(WebSocketMessage message)
protected WebSocketMessage	read() Read once from the input, if possible.
protected void	readingPaused() Invoked when reading is paused due to a lack of demand.

Methods inherited from class org.springframework.http.server.reactive.AbstractListenerReadPublisher

getLogPrefix, onAllDataRead, onDataAvailable, onError, subscribe

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pendingMessages

private volatile java.util.Queue<java.lang.Object> pendingMessages

Constructor Detail

WebSocketReceivePublisher

WebSocketReceivePublisher()

Method Detail

checkOnDataAvailable

protected void checkOnDataAvailable()

Description copied from class: AbstractListenerReadPublisher

Check if data is available and either call AbstractListenerReadPublisher.onDataAvailable() immediately or schedule a notification.

Specified by:

checkOnDataAvailable in class AbstractListenerReadPublisher<WebSocketMessage>

readingPaused

protected void readingPaused()

Description copied from class: AbstractListenerReadPublisher

Invoked when reading is paused due to a lack of demand.

Note: This method is guaranteed not to compete with AbstractListenerReadPublisher.checkOnDataAvailable() so it can be used to safely suspend reading, if the underlying API supports it, i.e. without competing with an implicit call to resume via checkOnDataAvailable().

Specified by:

readingPaused in class AbstractListenerReadPublisher<WebSocketMessage>

read

@Nullable
protected WebSocketMessage read()
                                   throws java.io.IOException

Description copied from class: AbstractListenerReadPublisher

Read once from the input, if possible.

Specified by:

read in class AbstractListenerReadPublisher<WebSocketMessage>

Returns:

the item that was read; or null

Throws:

java.io.IOException

handleMessage

void handleMessage(WebSocketMessage message)

discardData

protected void discardData()

Description copied from class: AbstractListenerReadPublisher

Invoked after an I/O read error from the underlying server or after a cancellation signal from the downstream consumer to allow sub-classes to discard any current cached data they might have.

Specified by:

discardData in class AbstractListenerReadPublisher<WebSocketMessage>