Class AbstractListenerWebSocketSession.WebSocketSendProcessor
java.lang.Object
org.springframework.http.server.reactive.AbstractListenerWriteProcessor<WebSocketMessage>
org.springframework.web.reactive.socket.adapter.AbstractListenerWebSocketSession.WebSocketSendProcessor
- All Implemented Interfaces:
Processor<WebSocketMessage,,Void> Publisher<Void>,Subscriber<WebSocketMessage>
- Enclosing class:
- AbstractListenerWebSocketSession<T>
protected final class AbstractListenerWebSocketSession.WebSocketSendProcessor
extends AbstractListenerWriteProcessor<WebSocketMessage>
Processor to send web socket messages.
-
Field Summary
Fields inherited from class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
rsWriteLogger -
Method Summary
Modifier and TypeMethodDescriptionprotected voiddiscardData(WebSocketMessage message) Invoked after any error (either from the upstream write Publisher, or from I/O operations to the underlying server) and cancellation to discard in-flight data that was in the process of being written when the error took place.protected booleanisDataEmpty(WebSocketMessage message) Whether the given data item has any content to write.protected booleanWhether writing is possible.voidsetReadyToSend(boolean ready) Sub-classes can invoke this before sending a message (false) and after receiving the async send callback (true) effective translating async completion callback into simple flow control.protected booleanwrite(WebSocketMessage message) Write the given item.Methods inherited from class org.springframework.http.server.reactive.AbstractListenerWriteProcessor
cancel, dataReceived, getLogPrefix, onComplete, onError, onNext, onSubscribe, onWritePossible, subscribe, writingComplete, writingFailed, writingPaused
-
Method Details
-
write
Description copied from class:AbstractListenerWriteProcessorWrite the given item.Note: Sub-classes are responsible for releasing any data buffer associated with the item, once fully written, if pooled buffers apply to the underlying container.
- Specified by:
writein classAbstractListenerWriteProcessor<WebSocketMessage>- Parameters:
message- the item to write- Returns:
trueif the current data item was written completely and a new item requested, orfalseif it was written partially and we'll need more write callbacks before it is fully written- Throws:
IOException
-
isDataEmpty
Description copied from class:AbstractListenerWriteProcessorWhether the given data item has any content to write. If false the item is not written.- Specified by:
isDataEmptyin classAbstractListenerWriteProcessor<WebSocketMessage>
-
isWritePossible
protected boolean isWritePossible()Description copied from class:AbstractListenerWriteProcessorWhether writing is possible.- Specified by:
isWritePossiblein classAbstractListenerWriteProcessor<WebSocketMessage>
-
setReadyToSend
public void setReadyToSend(boolean ready) Sub-classes can invoke this before sending a message (false) and after receiving the async send callback (true) effective translating async completion callback into simple flow control. -
discardData
Description copied from class:AbstractListenerWriteProcessorInvoked after any error (either from the upstream write Publisher, or from I/O operations to the underlying server) and cancellation to discard in-flight data that was in the process of being written when the error took place.- Specified by:
discardDatain classAbstractListenerWriteProcessor<WebSocketMessage>- Parameters:
message- the data to be released
-