org.springframework.http.server.reactive

Class AbstractListenerReadPublisher<T>

java.lang.Object

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

All Implemented Interfaces:

org.reactivestreams.Publisher<T>

public abstract class AbstractListenerReadPublisher<T>
extends Object
implements org.reactivestreams.Publisher<T>

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Log	logger

Constructor Summary

Constructors

Constructor and Description
AbstractListenerReadPublisher()

Method Summary

Modifier and Type	Method and Description
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(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.
void	subscribe(org.reactivestreams.Subscriber<? super T> 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

Constructor Detail

AbstractListenerReadPublisher

public AbstractListenerReadPublisher()

Method Detail

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super T> subscriber)

Specified by:

subscribe in interface org.reactivestreams.Publisher<T>

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(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 IOException

Reads a data from the input, if possible.

Returns:

the data that was read; or null

Throws:

IOException