Modifier and Type	Class and Description
private static enum	WriteResultPublisher.State Represents a state for the `Publisher` to be in. UNSUBSCRIBED \| v SUBSCRIBING \| v SUBSCRIBED \| v COMPLETED
private static class	WriteResultPublisher.WriteResultSubscription Subscription to receive and delegate request and cancel signals from the subscriber to this publisher.

Modifier and Type	Field and Description
private final Runnable	cancelTask
private volatile boolean	completedBeforeSubscribed
private volatile Throwable	errorBeforeSubscribed
private final String	logPrefix
private static final Log	rsWriteResultLogger Special logger for debugging Reactive Streams signals.
private final AtomicReference<WriteResultPublisher.State>	state
private volatile Subscriber<? super Void>	subscriber

Access	Constructor and Description
public	WriteResultPublisher(String logPrefix, Runnable cancelTask)

Method Summary

Modifier and Type	Method and Description
private boolean	changeState(WriteResultPublisher.State oldState, WriteResultPublisher.State newState)
public void	publishComplete() Invoke this to delegate a completion signal to the subscriber.
public void	publishError(Throwable t) Invoke this to delegate an error signal to the subscriber.
public final void	subscribe(Subscriber<? super Void> the `Subscriber` that will consume signals from this `Publisher` subscriber) Implements org.reactivestreams.Publisher.subscribe. Request `Publisher` to start streaming data.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cancelTask	back to summary
private final Runnable cancelTask

completedBeforeSubscribed	back to summary
private volatile boolean completedBeforeSubscribed

errorBeforeSubscribed	back to summary
private volatile Throwable errorBeforeSubscribed Annotations @Nullable

logPrefix	back to summary
private final String logPrefix

rsWriteResultLogger back to summary

rsWriteResultLogger	back to summary
private static final Log rsWriteResultLogger Special logger for debugging Reactive Streams signals. See Also `LogDelegateFactory#getHiddenLog(Class)`, `AbstractListenerReadPublisher#rsReadLogger`, `AbstractListenerWriteProcessor#rsWriteLogger`, `AbstractListenerWriteFlushProcessor#rsWriteFlushLogger`

private static final Log rsWriteResultLogger

Special logger for debugging Reactive Streams signals.

See Also: LogDelegateFactory#getHiddenLog(Class), AbstractListenerReadPublisher#rsReadLogger, AbstractListenerWriteProcessor#rsWriteLogger, AbstractListenerWriteFlushProcessor#rsWriteFlushLogger

state	back to summary
private final AtomicReference<WriteResultPublisher.State> state

subscriber	back to summary
private volatile Subscriber<? super Void> subscriber Annotations @Nullable

WriteResultPublisher	back to summary
public WriteResultPublisher(String logPrefix, Runnable cancelTask)

Method Detail

changeState	back to summary
private boolean changeState(WriteResultPublisher.State oldState, WriteResultPublisher.State newState)

publishComplete	back to summary
public void publishComplete() Invoke this to delegate a completion signal to the subscriber.

publishError	back to summary
public void publishError(Throwable t) Invoke this to delegate an error signal to the subscriber.

subscribe back to summary

subscribe	back to summary
public final void subscribe(Subscriber<? super Void> subscriber) Implements org.reactivestreams.Publisher.subscribe. Doc from org.reactivestreams.Publisher.subscribe. Request `Publisher` to start streaming data. This is a "factory method" and can be called multiple times, each time starting a new `Subscription`. Each `Subscription` will work for only a single `Subscriber`. A `Subscriber` should only subscribe once to a single `Publisher`. If the `Publisher` rejects the subscription attempt or otherwise fails it will signal the error via `Subscriber#onError(Throwable)`. Parameters subscriber:Subscriber<? super Void> the `Subscriber` that will consume signals from this `Publisher` Annotations @Override

public final void subscribe(Subscriber<? super Void> subscriber)

Implements org.reactivestreams.Publisher.subscribe.

Doc from org.reactivestreams.Publisher.subscribe.

Request Publisher to start streaming data.

This is a "factory method" and can be called multiple times, each time starting a new Subscription.

Each Subscription will work for only a single Subscriber.

A Subscriber should only subscribe once to a single Publisher.

If the Publisher rejects the subscription attempt or otherwise fails it will signal the error via Subscriber#onError(Throwable).

Parameters

subscriber:Subscriber<? super Void>: the Subscriber that will consume signals from this Publisher

Annotations

@Override

org.springframework.http.server.reactive back to summary

private sealed Enum WriteResultPublisher.State

Class Inheritance

extends Enum<WriteResultPublisher.State>

java.lang.Object
java.lang.Enum
org.springframework.http.server.reactive.WriteResultPublisher.State

Represents a state for the Publisher to be in.

    UNSUBSCRIBED
         |
         v
    SUBSCRIBING
         |
         v
     SUBSCRIBED
         |
         v
     COMPLETED

Field Summary

Modifier and Type	Field and Description
public static final WriteResultPublisher.State	COMPLETED
public static final WriteResultPublisher.State	SUBSCRIBED
public static final WriteResultPublisher.State	SUBSCRIBING
public static final WriteResultPublisher.State	UNSUBSCRIBED

Constructor Summary

Access	Constructor and Description
private	State()

Method Summary

Modifier and Type	Method and Description
pack-priv void	cancel(WriteResultPublisher publisher)
pack-priv void	publishComplete(WriteResultPublisher publisher)
pack-priv void	publishError(WriteResultPublisher publisher, Throwable t)
pack-priv void	request(WriteResultPublisher publisher, long n)
pack-priv void	subscribe(WriteResultPublisher publisher, Subscriber<? super Void> subscriber)
public static WriteResultPublisher.State	valueOf(String name)
public static WriteResultPublisher.State[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

COMPLETED	back to summary
public static final WriteResultPublisher.State COMPLETED

SUBSCRIBED	back to summary
public static final WriteResultPublisher.State SUBSCRIBED

SUBSCRIBING	back to summary
public static final WriteResultPublisher.State SUBSCRIBING

UNSUBSCRIBED	back to summary
public static final WriteResultPublisher.State UNSUBSCRIBED

Constructor Detail

State	back to summary
private State()

Method Detail

cancel	back to summary
pack-priv void cancel(WriteResultPublisher publisher)

publishComplete	back to summary
pack-priv void publishComplete(WriteResultPublisher publisher)

publishError	back to summary
pack-priv void publishError(WriteResultPublisher publisher, Throwable t)

request	back to summary
pack-priv void request(WriteResultPublisher publisher, long n)

subscribe	back to summary
pack-priv void subscribe(WriteResultPublisher publisher, Subscriber<? super Void> subscriber)

valueOf	back to summary
public static WriteResultPublisher.State valueOf(String name)

values	back to summary
public static WriteResultPublisher.State[] values()

org.springframework.http.server.reactive back to summary

private final Class WriteResultPublisher.WriteResultSubscription

Class Inheritance

extends Object
implements Subscription

java.lang.Object
org.springframework.http.server.reactive.WriteResultPublisher.WriteResultSubscription

All Implemented Interfaces

org.reactivestreams.Subscription

Subscription to receive and delegate request and cancel signals from the subscriber to this publisher.

Field Summary

Modifier and Type	Field and Description
private final WriteResultPublisher	publisher

Constructor Summary

Access	Constructor and Description
public	WriteResultSubscription(WriteResultPublisher publisher)

Method Summary

Modifier and Type	Method and Description
public final void	cancel() Implements org.reactivestreams.Subscription.cancel. Request the `Publisher` to stop sending data and clean up resources.
private WriteResultPublisher.State	getState()
public final void	request(long the strictly positive number of elements to requests to the upstream `Publisher` n) Implements org.reactivestreams.Subscription.request. No events will be sent by a `Publisher` until demand is signaled via this method.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

publisher	back to summary
private final WriteResultPublisher publisher

Constructor Detail

WriteResultSubscription	back to summary
public WriteResultSubscription(WriteResultPublisher publisher)

Method Detail

cancel back to summary

cancel	back to summary
public final void cancel() Implements org.reactivestreams.Subscription.cancel. Doc from org.reactivestreams.Subscription.cancel. Request the `Publisher` to stop sending data and clean up resources. Data may still be sent to meet previously signalled demand after calling cancel. Annotations @Override

public final void cancel()

Implements org.reactivestreams.Subscription.cancel.

Doc from org.reactivestreams.Subscription.cancel.

Request the Publisher to stop sending data and clean up resources.

Data may still be sent to meet previously signalled demand after calling cancel.

Annotations

@Override

getState	back to summary
private WriteResultPublisher.State getState()

request back to summary

request	back to summary
public final void request(long n) Implements org.reactivestreams.Subscription.request. Doc from org.reactivestreams.Subscription.request. No events will be sent by a `Publisher` until demand is signaled via this method. It can be called however often and whenever needed—but if the outstanding cumulative demand ever becomes Long.MAX_VALUE or more, it may be treated by the `Publisher` as "effectively unbounded". Whatever has been requested can be sent by the `Publisher` so only signal demand for what can be safely handled. A `Publisher` can send less than is requested if the stream ends but then must emit either `Subscriber#onError(Throwable)` or `Subscriber#onComplete()`. Parameters n:long the strictly positive number of elements to requests to the upstream `Publisher` Annotations @Override

public final void request(long n)

Implements org.reactivestreams.Subscription.request.

Doc from org.reactivestreams.Subscription.request.

No events will be sent by a Publisher until demand is signaled via this method.

It can be called however often and whenever needed—but if the outstanding cumulative demand ever becomes Long.MAX_VALUE or more, it may be treated by the Publisher as "effectively unbounded".

Whatever has been requested can be sent by the Publisher so only signal demand for what can be safely handled.

A Publisher can send less than is requested if the stream ends but then must emit either Subscriber#onError(Throwable) or Subscriber#onComplete().

Parameters

n:long: the strictly positive number of elements to requests to the upstream Publisher

Annotations

@Override

pack-priv Class WriteResultPublisher

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private sealed Enum WriteResultPublisher.State

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class WriteResultPublisher.WriteResultSubscription

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail