Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv class	SubscriberWrapper.DownstreamPusher Invoked whenever it 'may' be possible to push buffers downstream.
public static enum	SubscriberWrapper.SchedulingAction

Field Summary

Modifier and Type	Field and Description
private final CompletableFuture<Void>	cf
pack-priv volatile boolean	completionAcknowledged
pack-priv final Logger	debug
pack-priv volatile boolean	downstreamCompleted
private volatile Flow.Subscriber<? super List<ByteBuffer>>	downstreamSubscriber
pack-priv final SubscriptionBase	downstreamSubscription
private final AtomicReference<Throwable>	errorRef
private final ConcurrentLinkedQueue<List<ByteBuffer>>	outputQ
private final SequentialScheduler	pushScheduler
pack-priv volatile boolean	upstreamCompleted
pack-priv volatile Flow.Subscription	upstreamSubscription
pack-priv final AtomicLong	upstreamWindow

Constructor Summary

Access	Constructor and Description
public	SubscriberWrapper() Wraps the given downstream subscriber.
public	SubscriberWrapper(Flow.Subscriber<? super List<ByteBuffer>> downstream destination downstreamWrapper) Wraps the given downstream wrapper in this.

Method Summary

Modifier and Type	Method and Description
public void	addData(ByteBuffer l) Adds the given data to the input queue.
pack-priv void	checkCompletion()
public void	close() Implements java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public void	close(Throwable t)
public boolean	Returns: true, may be overridden by subclasses. closing() Sometime it might be necessary to complete the downstream subscriber before the upstream completes.
public CompletableFuture<Void>	completion() Returns a CompletableFuture which completes when this wrapper completes.
public String	dbgString()
pack-priv void	downstreamCompletion()
protected SubscriberWrapper.SchedulingAction	enterScheduling() Override this if anything needs to be done before checking for error and processing the input queue.
protected boolean	errorCommon(Throwable throwable)
pack-priv final boolean	hasNoOutputData()
protected abstract void	incoming(List<ByteBuffer> a List of ByteBuffers. buffers, boolean if true then no more data will be added to the list complete) Delivers data to be processed by this wrapper.
private void	incomingCaller(List<ByteBuffer> l, boolean complete)
protected long	Returns: The initial demand to request from upstream. initialUpstreamDemand() Initial demand that should be requested from upstream when we get the upstream subscription from `onSubscribe(Flow.Subscription)`.
public void	onComplete() Implements java.util.concurrent.Flow.Subscriber.onComplete. Method invoked when it is known that no additional Subscriber method invocations will occur for a Subscription that is not already terminated by error, after which no other Subscriber methods are invoked by the Subscription.
public void	onError(Throwable throwable) Implements java.util.concurrent.Flow.Subscriber.onError. Method invoked upon an unrecoverable error encountered by a Publisher or Subscription, after which no other Subscriber methods are invoked by the Subscription.
public void	onNext(List<ByteBuffer> item) Implements java.util.concurrent.Flow.Subscriber.onNext. Method invoked with a Subscription's next item.
protected void	onSubscribe() Override this if anything needs to be done after the upstream subscriber has subscribed
public void	onSubscribe(Flow.Subscription subscription) Implements java.util.concurrent.Flow.Subscriber.onSubscribe. Method invoked prior to invoking any other Subscriber methods for the given Subscription.
public void	outgoing(ByteBuffer buffer, boolean complete) Delivers buffers of data downstream.
public void	outgoing(List<ByteBuffer> buffers, boolean complete)
pack-priv final int	outputQueueSize()
protected void	requestMore()
public void	resetDownstreamDemand()
protected boolean	signalScheduling()
public final void	subscribe(Flow.Subscriber<? super List<ByteBuffer>> downstreamSubscriber) Implements java.util.concurrent.Flow.Publisher.subscribe. Adds the given Subscriber if possible.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.
private void	upstreamRequest(long n)
public long	upstreamWindow()
protected long	Returns: value to add to currentWindow upstreamWindowUpdate(long the current upstream subscription window currentWindow, long the current number of buffers waiting to be sent downstream downstreamQsize) This method is called to determine the window size to use at any time.
pack-priv void	upstreamWindowUpdate()

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

Field Detail

cf	back to summary
private final CompletableFuture<Void> cf

completionAcknowledged	back to summary
pack-priv volatile boolean completionAcknowledged

debug	back to summary
pack-priv final Logger debug

downstreamCompleted	back to summary
pack-priv volatile boolean downstreamCompleted

downstreamSubscriber	back to summary
private volatile Flow.Subscriber<? super List<ByteBuffer>> downstreamSubscriber

downstreamSubscription	back to summary
pack-priv final SubscriptionBase downstreamSubscription

errorRef	back to summary
private final AtomicReference<Throwable> errorRef

outputQ	back to summary
private final ConcurrentLinkedQueue<List<ByteBuffer>> outputQ

pushScheduler	back to summary
private final SequentialScheduler pushScheduler

upstreamCompleted	back to summary
pack-priv volatile boolean upstreamCompleted

upstreamSubscription	back to summary
pack-priv volatile Flow.Subscription upstreamSubscription

upstreamWindow	back to summary
pack-priv final AtomicLong upstreamWindow

Constructor Detail

SubscriberWrapper back to summary

SubscriberWrapper	back to summary
public SubscriberWrapper() Wraps the given downstream subscriber. For each call to `onNext(List<ByteBuffer>)` the given filter function is invoked and the list (if not empty) returned is passed downstream. A `CompletableFuture` is supplied which can be used to signal an error from downstream and which terminates the wrapper or which signals completion of downstream activity which can be propagated upstream. Error completion can be signaled at any time, but normal completion must not be signaled before onComplete() is called.

public SubscriberWrapper()

Wraps the given downstream subscriber. For each call to onNext(List<ByteBuffer>) the given filter function is invoked and the list (if not empty) returned is passed downstream. A CompletableFuture is supplied which can be used to signal an error from downstream and which terminates the wrapper or which signals completion of downstream activity which can be propagated upstream. Error completion can be signaled at any time, but normal completion must not be signaled before onComplete() is called.

SubscriberWrapper back to summary

SubscriberWrapper	back to summary
public SubscriberWrapper(Flow.Subscriber<? super List<ByteBuffer>> downstreamWrapper) Wraps the given downstream wrapper in this. For each call to `onNext(List<ByteBuffer>)` the incoming() method is called. The `downstreamCF` from the downstream wrapper is linked to this wrappers notifier. Parameters downstreamWrapper:Flow.Subscriber<? super List<ByteBuffer>> downstream destination

public SubscriberWrapper(Flow.Subscriber<? super List<ByteBuffer>> downstreamWrapper)

Wraps the given downstream wrapper in this. For each call to onNext(List<ByteBuffer>) the incoming() method is called. The downstreamCF from the downstream wrapper is linked to this wrappers notifier.

Parameters

downstreamWrapper:Flow.Subscriber<? super List<ByteBuffer>>: downstream destination

Method Detail

addData	back to summary
public void addData(ByteBuffer l) Adds the given data to the input queue.

checkCompletion	back to summary
pack-priv void checkCompletion()

close back to summary

close	back to summary
public void close() Implements java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override

public void close()

Implements java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

close	back to summary
public void close(Throwable t)

closing	back to summary
public boolean closing() Sometime it might be necessary to complete the downstream subscriber before the upstream completes. For instance, when an SSL server sends a notify_close. In that case we should let the outgoing complete before upstream is completed. Returns:boolean true, may be overridden by subclasses.

closing

back to summary

public boolean closing()

Sometime it might be necessary to complete the downstream subscriber before the upstream completes. For instance, when an SSL server sends a notify_close. In that case we should let the outgoing complete before upstream is completed.

Returns:boolean: true, may be overridden by subclasses.

completion	back to summary
public CompletableFuture<Void> completion() Returns a CompletableFuture which completes when this wrapper completes. Normal completion happens with the following steps (in order): 1. onComplete() is called 2. incoming() called with complete = true 3. outgoing() may continue to be called normally 4. outgoing called with complete = true 5. downstream subscriber is called onComplete() If the subscription is canceled or onComplete() is invoked the CompletableFuture completes exceptionally. Exceptional completion also occurs if downstreamCF completes exceptionally.

completion

back to summary

public CompletableFuture<Void> completion()

Returns a CompletableFuture which completes when this wrapper completes. Normal completion happens with the following steps (in order): 1. onComplete() is called 2. incoming() called with complete = true 3. outgoing() may continue to be called normally 4. outgoing called with complete = true 5. downstream subscriber is called onComplete() If the subscription is canceled or onComplete() is invoked the CompletableFuture completes exceptionally. Exceptional completion also occurs if downstreamCF completes exceptionally.

dbgString	back to summary
public String dbgString()

downstreamCompletion	back to summary
pack-priv void downstreamCompletion()

enterScheduling	back to summary
protected SubscriberWrapper.SchedulingAction enterScheduling() Override this if anything needs to be done before checking for error and processing the input queue.

errorCommon	back to summary
protected boolean errorCommon(Throwable throwable)

hasNoOutputData	back to summary
pack-priv final boolean hasNoOutputData()

incoming back to summary

incoming	back to summary
protected abstract void incoming(List<ByteBuffer> buffers, boolean complete) Delivers data to be processed by this wrapper. Generated data to be sent downstream, must be provided to the `outgoing(List, boolean)`} method. Parameters buffers:List<ByteBuffer> a List of ByteBuffers. complete:boolean if true then no more data will be added to the list

protected abstract void incoming(List<ByteBuffer> buffers, boolean complete)

Delivers data to be processed by this wrapper. Generated data to be sent downstream, must be provided to the outgoing(List, boolean)} method.

Parameters

buffers:List<ByteBuffer>: a List of ByteBuffers.
complete:boolean: if true then no more data will be added to the list

incomingCaller	back to summary
private void incomingCaller(List<ByteBuffer> l, boolean complete)

initialUpstreamDemand back to summary

initialUpstreamDemand	back to summary
protected long initialUpstreamDemand() Initial demand that should be requested from upstream when we get the upstream subscription from `onSubscribe(Flow.Subscription)`. Returns:long The initial demand to request from upstream.

protected long initialUpstreamDemand()

Initial demand that should be requested from upstream when we get the upstream subscription from onSubscribe(Flow.Subscription).

Returns:long: The initial demand to request from upstream.

onComplete	back to summary
public void onComplete() Implements java.util.concurrent.Flow.Subscriber.onComplete. Doc from java.util.concurrent.Flow.Subscriber.onComplete. Method invoked when it is known that no additional Subscriber method invocations will occur for a Subscription that is not already terminated by error, after which no other Subscriber methods are invoked by the Subscription. If this method throws an exception, resulting behavior is undefined. Annotations @Override

onComplete

back to summary

public void onComplete()

Implements java.util.concurrent.Flow.Subscriber.onComplete.

Doc from java.util.concurrent.Flow.Subscriber.onComplete.

Method invoked when it is known that no additional Subscriber method invocations will occur for a Subscription that is not already terminated by error, after which no other Subscriber methods are invoked by the Subscription. If this method throws an exception, resulting behavior is undefined.

Annotations

@Override

onError	back to summary
public void onError(Throwable throwable) Implements java.util.concurrent.Flow.Subscriber.onError. Doc from java.util.concurrent.Flow.Subscriber.onError. Method invoked upon an unrecoverable error encountered by a Publisher or Subscription, after which no other Subscriber methods are invoked by the Subscription. If this method itself throws an exception, resulting behavior is undefined. Annotations @Override

onError

back to summary

public void onError(Throwable throwable)

Implements java.util.concurrent.Flow.Subscriber.onError.

Doc from java.util.concurrent.Flow.Subscriber.onError.

Method invoked upon an unrecoverable error encountered by a Publisher or Subscription, after which no other Subscriber methods are invoked by the Subscription. If this method itself throws an exception, resulting behavior is undefined.

Annotations

@Override

onNext	back to summary
public void onNext(List<ByteBuffer> item) Implements java.util.concurrent.Flow.Subscriber.onNext. Doc from java.util.concurrent.Flow.Subscriber.onNext. Method invoked with a Subscription's next item. If this method throws an exception, resulting behavior is not guaranteed, but may cause the Subscription to be cancelled. Annotations @Override

onNext

back to summary

public void onNext(List<ByteBuffer> item)

Implements java.util.concurrent.Flow.Subscriber.onNext.

Doc from java.util.concurrent.Flow.Subscriber.onNext.

Method invoked with a Subscription's next item. If this method throws an exception, resulting behavior is not guaranteed, but may cause the Subscription to be cancelled.

Annotations

@Override

onSubscribe	back to summary
protected void onSubscribe() Override this if anything needs to be done after the upstream subscriber has subscribed

onSubscribe back to summary

onSubscribe	back to summary
public void onSubscribe(Flow.Subscription subscription) Implements java.util.concurrent.Flow.Subscriber.onSubscribe. Doc from java.util.concurrent.Flow.Subscriber.onSubscribe. Method invoked prior to invoking any other Subscriber methods for the given Subscription. If this method throws an exception, resulting behavior is not guaranteed, but may cause the Subscription not to be established or to be cancelled. Typically, implementations of this method invoke `subscription.request` to enable receiving items. Annotations @Override

public void onSubscribe(Flow.Subscription subscription)

Implements java.util.concurrent.Flow.Subscriber.onSubscribe.

Doc from java.util.concurrent.Flow.Subscriber.onSubscribe.

Method invoked prior to invoking any other Subscriber methods for the given Subscription. If this method throws an exception, resulting behavior is not guaranteed, but may cause the Subscription not to be established or to be cancelled.

Typically, implementations of this method invoke subscription.request to enable receiving items.

Annotations

@Override

outgoing	back to summary
public void outgoing(ByteBuffer buffer, boolean complete) Delivers buffers of data downstream. After incoming() has been called complete == true signifying completion of the upstream subscription, data may continue to be delivered, up to when outgoing() is called complete == true, after which, the downstream subscription is completed. It's an error to call outgoing() with complete = true if incoming() has not previously been called with it.

outgoing

back to summary

public void outgoing(ByteBuffer buffer, boolean complete)

Delivers buffers of data downstream. After incoming() has been called complete == true signifying completion of the upstream subscription, data may continue to be delivered, up to when outgoing() is called complete == true, after which, the downstream subscription is completed. It's an error to call outgoing() with complete = true if incoming() has not previously been called with it.

outgoing	back to summary
public void outgoing(List<ByteBuffer> buffers, boolean complete)

outputQueueSize	back to summary
pack-priv final int outputQueueSize()

requestMore	back to summary
protected void requestMore()

resetDownstreamDemand	back to summary
public void resetDownstreamDemand()

signalScheduling	back to summary
protected boolean signalScheduling()

subscribe back to summary

subscribe	back to summary
public final void subscribe(Flow.Subscriber<? super List<ByteBuffer>> downstreamSubscriber) Implements java.util.concurrent.Flow.Publisher.subscribe. Doc from java.util.concurrent.Flow.Publisher.subscribe. Adds the given Subscriber if possible. If already subscribed, or the attempt to subscribe fails due to policy violations or errors, the Subscriber's `onError` method is invoked with an `IllegalStateException`. Otherwise, the Subscriber's `onSubscribe` method is invoked with a new `Subscription`. Subscribers may enable receiving items by invoking the `request` method of this Subscription, and may unsubscribe by invoking its `cancel` method. Annotations @Override

public final void subscribe(Flow.Subscriber<? super List<ByteBuffer>> downstreamSubscriber)

Implements java.util.concurrent.Flow.Publisher.subscribe.

Doc from java.util.concurrent.Flow.Publisher.subscribe.

Adds the given Subscriber if possible. If already subscribed, or the attempt to subscribe fails due to policy violations or errors, the Subscriber's onError method is invoked with an IllegalStateException. Otherwise, the Subscriber's onSubscribe method is invoked with a new Subscription. Subscribers may enable receiving items by invoking the request method of this Subscription, and may unsubscribe by invoking its cancel method.

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

upstreamRequest	back to summary
private void upstreamRequest(long n)

upstreamWindow	back to summary
public long upstreamWindow()

upstreamWindowUpdate back to summary

upstreamWindowUpdate	back to summary
protected long upstreamWindowUpdate(long currentWindow, long downstreamQsize) This method is called to determine the window size to use at any time. The current window is supplied together with the current downstream queue size. `0` should be returned if no change is required or a positive integer which will be added to the current window. The default implementation maintains a downstream queue size of no greater than 5. The method can be overridden if required. Parameters currentWindow:long the current upstream subscription window downstreamQsize:long the current number of buffers waiting to be sent downstream Returns:long value to add to currentWindow

protected long upstreamWindowUpdate(long currentWindow, long downstreamQsize)

This method is called to determine the window size to use at any time. The current window is supplied together with the current downstream queue size. 0 should be returned if no change is required or a positive integer which will be added to the current window. The default implementation maintains a downstream queue size of no greater than 5. The method can be overridden if required.

Parameters

currentWindow:long: the current upstream subscription window
downstreamQsize:long: the current number of buffers waiting to be sent downstream

Returns:long

value to add to currentWindow

upstreamWindowUpdate	back to summary
pack-priv void upstreamWindowUpdate()

jdk.internal.net.http.common back to summary

pack-priv Class SubscriberWrapper.DownstreamPusher

Class Inheritance

extends Object
implements Runnable

java.lang.Object
jdk.internal.net.http.common.SubscriberWrapper.DownstreamPusher

All Implemented Interfaces

java.lang.Runnable

Invoked whenever it 'may' be possible to push buffers downstream.

Constructor Summary

Access	Constructor and Description
pack-priv	DownstreamPusher()

Method Summary

Modifier and Type	Method and Description
public void	run() Implements java.lang.Runnable.run. Runs this operation.
private void	run1()

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

Constructor Detail

DownstreamPusher	back to summary
pack-priv DownstreamPusher()

Method Detail

run

back to summary

public void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

run1	back to summary
private void run1()

jdk.internal.net.http.common back to summary

public final Enum SubscriberWrapper.SchedulingAction

Class Inheritance

extends Enum<SubscriberWrapper.SchedulingAction>

java.lang.Object
java.lang.Enum
jdk.internal.net.http.common.SubscriberWrapper.SchedulingAction

Field Summary

Modifier and Type	Field and Description
public static final SubscriberWrapper.SchedulingAction	CONTINUE
public static final SubscriberWrapper.SchedulingAction	RESCHEDULE
public static final SubscriberWrapper.SchedulingAction	RETURN

Constructor Summary

Access	Constructor and Description
private	SchedulingAction()

Method Summary

Modifier and Type	Method and Description
public static SubscriberWrapper.SchedulingAction	valueOf(String name)
public static SubscriberWrapper.SchedulingAction[]	values()

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

Field Detail

CONTINUE	back to summary
public static final SubscriberWrapper.SchedulingAction CONTINUE

RESCHEDULE	back to summary
public static final SubscriberWrapper.SchedulingAction RESCHEDULE

RETURN	back to summary
public static final SubscriberWrapper.SchedulingAction RETURN

Constructor Detail

SchedulingAction	back to summary
private SchedulingAction()

Method Detail

valueOf	back to summary
public static SubscriberWrapper.SchedulingAction valueOf(String name)

values	back to summary
public static SubscriberWrapper.SchedulingAction[] values()

public abstract Class SubscriberWrapper

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class SubscriberWrapper.DownstreamPusher

Constructor Summary

Method Summary

Constructor Detail

Method Detail

public final Enum SubscriberWrapper.SchedulingAction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail