org.springframework.http.server.reactive

Class AbstractListenerReadPublisher<T>

java.lang.Object

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

Direct Known Subclasses:

AbstractListenerWebSocketSession.WebSocketReceivePublisher, ServletServerHttpRequest.RequestBodyPublisher, UndertowServerHttpRequest.RequestBodyPublisher

public abstract class AbstractListenerReadPublisher<T>
extends java.lang.Object

Abstract base class for Publisher implementations that bridge between event-listener read APIs and Reactive Streams.

Specifically a base class for reading from the HTTP request body with Servlet 3.1 non-blocking I/O and Undertow XNIO as well as handling incoming WebSocket messages with standard Java WebSocket (JSR-356), Jetty, and Undertow.

Since:

5.0

Author:

Arjen Poutsma, Violeta Georgieva, Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	AbstractListenerReadPublisher.ReadSubscription
private static class	AbstractListenerReadPublisher.State Represents a state for the Publisher to be in.

Field Summary

Fields

Modifier and Type	Field and Description
private long	demand
private static java.util.concurrent.atomic.AtomicLongFieldUpdater<AbstractListenerReadPublisher>	DEMAND_FIELD_UPDATER
protected Log	logger
private java.util.concurrent.atomic.AtomicReference<AbstractListenerReadPublisher.State>	state
private <any>	subscriber

Constructor Summary

Constructors

Constructor and Description
AbstractListenerReadPublisher()

Method Summary

Modifier and Type	Method and Description
private boolean	changeState(AbstractListenerReadPublisher.State oldState, AbstractListenerReadPublisher.State newState)
protected abstract void	checkOnDataAvailable()
void	onAllDataRead() Listeners can call this to notify when all data has been read.
void	onDataAvailable() Listeners can call this to notify when reading is possible.
void	onError(java.lang.Throwable t) Listeners can call this to notify when a read error has occurred.
protected abstract T	read() Reads a data from the input, if possible.
private boolean	readAndPublish() Read and publish data from the input.
void	subscribe(<any> subscriber)

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final Log logger

state

private final java.util.concurrent.atomic.AtomicReference<AbstractListenerReadPublisher.State> state

demand

private volatile long demand

DEMAND_FIELD_UPDATER

private static final java.util.concurrent.atomic.AtomicLongFieldUpdater<AbstractListenerReadPublisher> DEMAND_FIELD_UPDATER

subscriber

private <any> subscriber

Constructor Detail

AbstractListenerReadPublisher

public AbstractListenerReadPublisher()

Method Detail

subscribe

public void subscribe(<any> subscriber)

onDataAvailable

public final void onDataAvailable()

Listeners can call this to notify when reading is possible.

onAllDataRead

public void onAllDataRead()

Listeners can call this to notify when all data has been read.

onError

public final void onError(java.lang.Throwable t)

Listeners can call this to notify when a read error has occurred.

checkOnDataAvailable

protected abstract void checkOnDataAvailable()

read

protected abstract T read()
                   throws java.io.IOException

Reads a data from the input, if possible.

Returns:

the data that was read; or null

Throws:

java.io.IOException

readAndPublish

private boolean readAndPublish()
                        throws java.io.IOException

Read and publish data from the input. Continue till there is no more demand or there is no more data to be read.

Returns:

true if there is more demand; false otherwise

Throws:

java.io.IOException

changeState

private boolean changeState(AbstractListenerReadPublisher.State oldState,
                            AbstractListenerReadPublisher.State newState)