org.springframework.http.server.reactive

Class AbstractListenerWriteFlushProcessor<T>

java.lang.Object

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

All Implemented Interfaces:

org.reactivestreams.Processor<org.reactivestreams.Publisher<? extends T>,java.lang.Void>, org.reactivestreams.Publisher<java.lang.Void>, org.reactivestreams.Subscriber<org.reactivestreams.Publisher<? extends T>>

public abstract class AbstractListenerWriteFlushProcessor<T>
extends java.lang.Object
implements org.reactivestreams.Processor<org.reactivestreams.Publisher<? extends T>,java.lang.Void>

An alternative to AbstractListenerWriteProcessor but instead writing a Publisher<Publisher<T>> with flush boundaries enforces after the completion of each nested Publisher.

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
AbstractListenerWriteFlushProcessor()

Method Summary

Modifier and Type	Method and Description
protected void	cancel() Listeners can call this method to cancel further writing.
protected abstract org.reactivestreams.Processor<? super T,java.lang.Void>	createWriteProcessor() Create a new processor for subscribing to the next flush boundary.
protected abstract void	flush() Flush the output.
protected void	flushingFailed(java.lang.Throwable t) Invoked when an error happens while flushing.
protected abstract boolean	isFlushPending() Whether flushing is pending.
protected abstract boolean	isWritePossible() Whether writing is possible.
void	onComplete()
void	onError(java.lang.Throwable t)
protected void	onFlushPossible() Listeners can call this to notify when flushing is possible.
void	onNext(org.reactivestreams.Publisher<? extends T> publisher)
void	onSubscribe(org.reactivestreams.Subscription subscription)
void	subscribe(org.reactivestreams.Subscriber<? super java.lang.Void> 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

AbstractListenerWriteFlushProcessor

public AbstractListenerWriteFlushProcessor()

Method Detail

onSubscribe

public final void onSubscribe(org.reactivestreams.Subscription subscription)

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<org.reactivestreams.Publisher<? extends T>>

onNext

public final void onNext(org.reactivestreams.Publisher<? extends T> publisher)

Specified by:

onNext in interface org.reactivestreams.Subscriber<org.reactivestreams.Publisher<? extends T>>

onError

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

Specified by:

onError in interface org.reactivestreams.Subscriber<org.reactivestreams.Publisher<? extends T>>

onComplete

public final void onComplete()

Specified by:

onComplete in interface org.reactivestreams.Subscriber<org.reactivestreams.Publisher<? extends T>>

subscribe

public final void subscribe(org.reactivestreams.Subscriber<? super java.lang.Void> subscriber)

Specified by:

subscribe in interface org.reactivestreams.Publisher<java.lang.Void>

cancel

protected void cancel()

Listeners can call this method to cancel further writing.

flushingFailed

protected void flushingFailed(java.lang.Throwable t)

Invoked when an error happens while flushing. Defaults to no-op. Servlet 3.1 based implementations will receive an AsyncListener.onError(javax.servlet.AsyncEvent) event.

createWriteProcessor

protected abstract org.reactivestreams.Processor<? super T,java.lang.Void> createWriteProcessor()

Create a new processor for subscribing to the next flush boundary.

flush

protected abstract void flush()
                       throws java.io.IOException

Flush the output.

Throws:

java.io.IOException

isWritePossible

protected abstract boolean isWritePossible()

Whether writing is possible.

isFlushPending

protected abstract boolean isFlushPending()

Whether flushing is pending.

onFlushPossible

protected final void onFlushPossible()

Listeners can call this to notify when flushing is possible.