Modifier and Type	Class and Description
public static interface	OutputStreamPublisher.ByteMapper< the type to map to T> Maps bytes written to in `OutputStreamHandler#handle(OutputStream)` to published items.
public static interface	OutputStreamPublisher.OutputStreamHandler Defines the contract for handling the `OutputStream` provided by the `OutputStreamPublisher`.
private static class	OutputStreamPublisher.OutputStreamSubscription<T>

Modifier and Type	Field and Description
private final OutputStreamPublisher.ByteMapper<T>	byteMapper
private final int	chunkSize
private static final int	DEFAULT_CHUNK_SIZE
private final Executor	executor
private final OutputStreamPublisher.OutputStreamHandler	outputStreamHandler

Access	Constructor and Description
private	OutputStreamPublisher(OutputStreamPublisher.OutputStreamHandler outputStreamHandler, OutputStreamPublisher.ByteMapper<T> byteMapper, Executor executor, int chunkSize)

Method Summary

Modifier and Type	Method and Description
public static < the publisher type T> Flow.Publisher<T>	Returns: a `Publisher<T>` based on bytes written by `outputStreamHandler` mapped by `byteMapper` create(OutputStreamPublisher.OutputStreamHandler invoked when the first buffer is requested outputStreamHandler, OutputStreamPublisher.ByteMapper<T> maps written bytes to `T` byteMapper, Executor used to invoke the `outputStreamHandler` executor) Creates a new `Publisher<T>` based on bytes written to a `OutputStream`.
public static < the publisher type T> Flow.Publisher<T>	Returns: a `Publisher<T>` based on bytes written by `outputStreamHandler` mapped by `byteMapper` create(OutputStreamPublisher.OutputStreamHandler invoked when the first buffer is requested outputStreamHandler, OutputStreamPublisher.ByteMapper<T> maps written bytes to `T` byteMapper, Executor used to invoke the `outputStreamHandler` executor, int chunkSize) Creates a new `Publisher<T>` based on bytes written to a `OutputStream`.
public void	subscribe(Flow.Subscriber<? super T> the subscriber subscriber) Implements java.util.concurrent.Flow.Publisher.subscribe. Adds the given Subscriber if possible.

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

Field Detail

byteMapper	back to summary
private final OutputStreamPublisher.ByteMapper<T> byteMapper

chunkSize	back to summary
private final int chunkSize

DEFAULT_CHUNK_SIZE	back to summary
private static final int DEFAULT_CHUNK_SIZE

executor	back to summary
private final Executor executor

outputStreamHandler	back to summary
private final OutputStreamPublisher.OutputStreamHandler outputStreamHandler

Constructor Detail

OutputStreamPublisher	back to summary
private OutputStreamPublisher(OutputStreamPublisher.OutputStreamHandler outputStreamHandler, OutputStreamPublisher.ByteMapper<T> byteMapper, Executor executor, int chunkSize)

Method Detail

create back to summary

create	back to summary
public static <T> Flow.Publisher<T> create(OutputStreamPublisher.OutputStreamHandler outputStreamHandler, OutputStreamPublisher.ByteMapper<T> byteMapper, Executor executor) Creates a new `Publisher<T>` based on bytes written to a `OutputStream`. The parameter `byteMapper` is used to map from written bytes to the published type. The parameter `outputStreamHandler` is invoked once per subscription of the returned `Publisher`, when the first item is requested. `OutputStream.write()` invocations made by `outputStreamHandler` are buffered until they exceed the default chunk size of 1024, and then result in a published item if there is demand. If there is no demand, `OutputStream.write()` will block until there is. If the subscription is cancelled, `OutputStream.write()` will throw a `IOException`. The subscription is completed when `outputStreamHandler` completes. Any `IOException`s thrown from `outputStreamHandler` will be dispatched to the Subscriber. Parameters <T> the publisher type outputStreamHandler:OutputStreamPublisher.OutputStreamHandler invoked when the first buffer is requested byteMapper:OutputStreamPublisher.ByteMapper<T> maps written bytes to `T` executor:Executor used to invoke the `outputStreamHandler` Returns:Flow.Publisher<T> a `Publisher<T>` based on bytes written by `outputStreamHandler` mapped by `byteMapper`

public static <T> Flow.Publisher<T> create(OutputStreamPublisher.OutputStreamHandler outputStreamHandler, OutputStreamPublisher.ByteMapper<T> byteMapper, Executor executor)

Creates a new Publisher<T> based on bytes written to a OutputStream. The parameter byteMapper is used to map from written bytes to the published type.

The parameter outputStreamHandler is invoked once per subscription of the returned Publisher, when the first item is requested.
OutputStream.write() invocations made by outputStreamHandler are buffered until they exceed the default chunk size of 1024, and then result in a published item if there is demand.
If there is no demand, OutputStream.write() will block until there is.
If the subscription is cancelled, OutputStream.write() will throw a IOException.
The subscription is completed when outputStreamHandler completes.
Any IOExceptions thrown from outputStreamHandler will be dispatched to the Subscriber.

Parameters

<T>: the publisher type
outputStreamHandler:OutputStreamPublisher.OutputStreamHandler: invoked when the first buffer is requested
byteMapper:OutputStreamPublisher.ByteMapper<T>: maps written bytes to T
executor:Executor: used to invoke the outputStreamHandler

Returns:Flow.Publisher<T>

a Publisher<T> based on bytes written by outputStreamHandler mapped by byteMapper

create back to summary

create	back to summary
public static <T> Flow.Publisher<T> create(OutputStreamPublisher.OutputStreamHandler outputStreamHandler, OutputStreamPublisher.ByteMapper<T> byteMapper, Executor executor, int chunkSize) Creates a new `Publisher<T>` based on bytes written to a `OutputStream`. The parameter `byteMapper` is used to map from written bytes to the published type. The parameter `outputStreamHandler` is invoked once per subscription of the returned `Publisher`, when the first item is requested. `OutputStream.write()` invocations made by `outputStreamHandler` are buffered until they exceed `chunkSize`, and then result in a published item if there is demand. If there is no demand, `OutputStream.write()` will block until there is. If the subscription is cancelled, `OutputStream.write()` will throw a `IOException`. The subscription is completed when `outputStreamHandler` completes. Any `IOException`s thrown from `outputStreamHandler` will be dispatched to the Subscriber. Parameters <T> the publisher type outputStreamHandler:OutputStreamPublisher.OutputStreamHandler invoked when the first buffer is requested byteMapper:OutputStreamPublisher.ByteMapper<T> maps written bytes to `T` executor:Executor used to invoke the `outputStreamHandler` Returns:Flow.Publisher<T> a `Publisher<T>` based on bytes written by `outputStreamHandler` mapped by `byteMapper`

public static <T> Flow.Publisher<T> create(OutputStreamPublisher.OutputStreamHandler outputStreamHandler, OutputStreamPublisher.ByteMapper<T> byteMapper, Executor executor, int chunkSize)

Creates a new Publisher<T> based on bytes written to a OutputStream. The parameter byteMapper is used to map from written bytes to the published type.

The parameter outputStreamHandler is invoked once per subscription of the returned Publisher, when the first item is requested.
OutputStream.write() invocations made by outputStreamHandler are buffered until they exceed chunkSize, and then result in a published item if there is demand.
If there is no demand, OutputStream.write() will block until there is.
If the subscription is cancelled, OutputStream.write() will throw a IOException.
The subscription is completed when outputStreamHandler completes.
Any IOExceptions thrown from outputStreamHandler will be dispatched to the Subscriber.

Parameters

<T>: the publisher type
outputStreamHandler:OutputStreamPublisher.OutputStreamHandler: invoked when the first buffer is requested
byteMapper:OutputStreamPublisher.ByteMapper<T>: maps written bytes to T
executor:Executor: used to invoke the outputStreamHandler

Returns:Flow.Publisher<T>

a Publisher<T> based on bytes written by outputStreamHandler mapped by byteMapper

subscribe back to summary

subscribe	back to summary
public void subscribe(Flow.Subscriber<? super T> subscriber) 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. Parameters subscriber:Flow.Subscriber<? super T> the subscriber Annotations @Override

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

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.

Parameters

subscriber:Flow.Subscriber<? super T>: the subscriber

Annotations

@Override

org.springframework.http.client back to summary

public Interface OutputStreamPublisher.ByteMapper<T>

Known Direct Implementers

org.springframework.http.client.ReactorNettyClientRequest.ByteBufMapper, org.springframework.http.client.JdkClientHttpRequest.ByteBufferMapper

Type Parameters

<T>: the type to map to

Maps bytes written to in OutputStreamHandler#handle(OutputStream) to published items.

Method Summary

Modifier and Type	Method and Description
public T	map(int b) Maps a single byte to `T`.
public T	map(byte[] b, int off, int len) Maps a byte array to `T`.

Method Detail

map	back to summary
public T map(int b) Maps a single byte to `T`.

map	back to summary
public T map(byte[] b, int off, int len) Maps a byte array to `T`.

org.springframework.http.client back to summary

public Interface OutputStreamPublisher.OutputStreamHandler

Annotations

@FunctionalInterface

Defines the contract for handling the OutputStream provided by the OutputStreamPublisher.

Method Summary

Modifier and Type	Method and Description
public void	handle(OutputStream the stream to write to outputStream) Use the given stream for writing.

Method Detail

handle back to summary

handle	back to summary
public void handle(OutputStream outputStream) throws IOException Use the given stream for writing. If the linked subscription has demand, any written bytes will be mapped and published to the `Subscriber`. If there is no demand, any `write()` invocations will block until there is demand. If the linked subscription is cancelled, `write()` invocations will result in a `IOException`. Parameters outputStream:OutputStream the stream to write to Exceptions IOException: any thrown I/O errors will be dispatched to the Subscriber

public void handle(OutputStream outputStream) throws IOException

Use the given stream for writing.

If the linked subscription has demand, any written bytes will be mapped and published to the Subscriber.
If there is no demand, any write() invocations will block until there is demand.
If the linked subscription is cancelled, write() invocations will result in a IOException.

Parameters

outputStream:OutputStream: the stream to write to

Exceptions

IOException:: any thrown I/O errors will be dispatched to the Subscriber

org.springframework.http.client back to summary

private final Class OutputStreamPublisher.OutputStreamSubscription<T>

Class Inheritance

extends OutputStream
implements Subscription

java.lang.Object
java.io.OutputStream
org.springframework.http.client.OutputStreamPublisher.OutputStreamSubscription

All Implemented Interfaces

java.util.concurrent.Flow.Subscription

Field Summary

Modifier and Type	Field and Description
private final Flow.Subscriber<? super T>	actual
private final OutputStreamPublisher.ByteMapper<T>	byteMapper
private final int	chunkSize
private volatile Throwable	error
private final OutputStreamPublisher.OutputStreamHandler	outputStreamHandler
private final AtomicReference<Object>	parkedThread
private long	produced
pack-priv static final Object	READY
private final AtomicLong	requested

Constructor Summary

Access	Constructor and Description
public	OutputStreamSubscription(Flow.Subscriber<? super T> actual, OutputStreamPublisher.OutputStreamHandler outputStreamHandler, OutputStreamPublisher.ByteMapper<T> byteMapper, int chunkSize)

Method Summary

Modifier and Type	Method and Description
private long	addCap(long n)
private static long	addCap(long a, long b)
private void	await()
public void	cancel() Implements java.util.concurrent.Flow.Subscription.cancel. Causes the Subscriber to (eventually) stop receiving messages.
private void	checkDemandAndAwaitIfNeeded()
private void	invokeHandler()
private static boolean	isCancelled(long state)
private static boolean	isTerminated(long state)
public void	request(long the increment of demand; a value of `Long.MAX_VALUE` may be considered as effectively unbounded n) Implements java.util.concurrent.Flow.Subscription.request. Adds the given number `n` of items to the current unfulfilled demand for this subscription.
private void	resume()
private long	tryCancel()
private long	tryProduce(long n)
private long	tryTerminate()
public void	write(int the `byte`. b) Implements abstract java.io.OutputStream.write. Writes the specified byte to this output stream.
public void	write(byte[] the data. b) Overrides java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream.
public void	write(byte[] the data. b, int the start offset in the data. off, int the number of bytes to write. len) Overrides java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream.

Inherited from java.io.OutputStream:: close flush nullOutputStream

Field Detail

actual	back to summary
private final Flow.Subscriber<? super T> actual

byteMapper	back to summary
private final OutputStreamPublisher.ByteMapper<T> byteMapper

chunkSize	back to summary
private final int chunkSize

error	back to summary
private volatile Throwable error Annotations @Nullable

outputStreamHandler	back to summary
private final OutputStreamPublisher.OutputStreamHandler outputStreamHandler

parkedThread	back to summary
private final AtomicReference<Object> parkedThread

produced	back to summary
private long produced

READY	back to summary
pack-priv static final Object READY

requested	back to summary
private final AtomicLong requested

Constructor Detail

OutputStreamSubscription	back to summary
public OutputStreamSubscription(Flow.Subscriber<? super T> actual, OutputStreamPublisher.OutputStreamHandler outputStreamHandler, OutputStreamPublisher.ByteMapper<T> byteMapper, int chunkSize)

Method Detail

addCap	back to summary
private long addCap(long n)

addCap	back to summary
private static long addCap(long a, long b)

await	back to summary
private void await()

cancel back to summary

cancel	back to summary
public void cancel() Implements java.util.concurrent.Flow.Subscription.cancel. Doc from java.util.concurrent.Flow.Subscription.cancel. Causes the Subscriber to (eventually) stop receiving messages. Implementation is best-effort -- additional messages may be received after invoking this method. A cancelled subscription need not ever receive an `onComplete` or `onError` signal. Annotations @Override

public void cancel()

Implements java.util.concurrent.Flow.Subscription.cancel.

Doc from java.util.concurrent.Flow.Subscription.cancel.

Causes the Subscriber to (eventually) stop receiving messages. Implementation is best-effort -- additional messages may be received after invoking this method. A cancelled subscription need not ever receive an onComplete or onError signal.

Annotations

@Override

checkDemandAndAwaitIfNeeded	back to summary
private void checkDemandAndAwaitIfNeeded() throws IOException

invokeHandler	back to summary
private void invokeHandler()

isCancelled	back to summary
private static boolean isCancelled(long state)

isTerminated	back to summary
private static boolean isTerminated(long state)

request back to summary

request	back to summary
public void request(long n) Implements java.util.concurrent.Flow.Subscription.request. Doc from java.util.concurrent.Flow.Subscription.request. Adds the given number `n` of items to the current unfulfilled demand for this subscription. If `n` is less than or equal to zero, the Subscriber will receive an `onError` signal with an `IllegalArgumentException` argument. Otherwise, the Subscriber will receive up to `n` additional `onNext` invocations (or fewer if terminated). Parameters n:long the increment of demand; a value of `Long.MAX_VALUE` may be considered as effectively unbounded Annotations @Override

public void request(long n)

Implements java.util.concurrent.Flow.Subscription.request.

Doc from java.util.concurrent.Flow.Subscription.request.

Adds the given number n of items to the current unfulfilled demand for this subscription. If n is less than or equal to zero, the Subscriber will receive an onError signal with an IllegalArgumentException argument. Otherwise, the Subscriber will receive up to n additional onNext invocations (or fewer if terminated).

Parameters

n:long: the increment of demand; a value of Long.MAX_VALUE may be considered as effectively unbounded

Annotations

@Override

resume	back to summary
private void resume()

tryCancel	back to summary
private long tryCancel()

tryProduce	back to summary
private long tryProduce(long n)

tryTerminate	back to summary
private long tryTerminate()

write back to summary

write	back to summary
public void write(int b) throws IOException Implements abstract java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes the specified byte to this output stream. The general contract for `write` is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument `b`. The 24 high-order bits of `b` are ignored. Parameters b:int the `byte`. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` may be thrown if the output stream has been closed.

public void write(int b) throws IOException

Implements abstract java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes the specified byte to this output stream. The general contract for write is that one byte is written to the output stream. The byte to be written is the eight low-order bits of the argument b. The 24 high-order bits of b are ignored.

Parameters

b:int: the byte.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

write back to summary

write	back to summary
public void write(byte[] b) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `b.length` bytes from the specified byte array to this output stream. The general contract for `write(b)` is that it should have exactly the same effect as the call `write(b, 0, b.length)`. Parameters b:byte[] the data. Annotations @Override Exceptions IOException: if an I/O error occurs.

public void write(byte[] b) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes b.length bytes from the specified byte array to this output stream. The general contract for write(b) is that it should have exactly the same effect as the call write(b, 0, b.length).

Parameters

b:byte[]: the data.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs.

write back to summary

write	back to summary
public void write(byte[] b, int off, int len) throws IOException Overrides java.io.OutputStream.write. Doc from java.io.OutputStream.write. Writes `len` bytes from the specified byte array starting at offset `off` to this output stream. The general contract for `write(b, off, len)` is that some of the bytes in the array `b` are written to the output stream in order; element `b[off]` is the first byte written and `b[off+len-1]` is the last byte written by this operation. If `b` is `null`, a `NullPointerException` is thrown. If `off` is negative, or `len` is negative, or `off+len` is greater than the length of the array `b`, then an `IndexOutOfBoundsException` is thrown. Parameters b:byte[] the data. off:int the start offset in the data. len:int the number of bytes to write. Annotations @Override Exceptions IOException: if an I/O error occurs. In particular, an `IOException` is thrown if the output stream is closed.

public void write(byte[] b, int off, int len) throws IOException

Overrides java.io.OutputStream.write.

Doc from java.io.OutputStream.write.

Writes len bytes from the specified byte array starting at offset off to this output stream. The general contract for write(b, off, len) is that some of the bytes in the array b are written to the output stream in order; element b[off] is the first byte written and b[off+len-1] is the last byte written by this operation.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Parameters

b:byte[]: the data.
off:int: the start offset in the data.
len:int: the number of bytes to write.

Annotations

@Override

Exceptions

IOException:: if an I/O error occurs. In particular, an IOException is thrown if the output stream is closed.

pack-priv final Class OutputStreamPublisher<T>

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface OutputStreamPublisher.ByteMapper<T>

Method Summary

Method Detail

public Interface OutputStreamPublisher.OutputStreamHandler

Method Summary

Method Detail

private final Class OutputStreamPublisher.OutputStreamSubscription<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail