Rename InputStreamSubscriber to SubscriberInputStream

It is both, but InputStream is what's exposed for public use,
in effect an InputStream backed by a Subscriber source.

See gh-31677
This commit is contained in:
rstoyanchev
2024-10-25 17:39:55 +01:00
parent 86a42db002
commit dfaf7a0c6a
5 changed files with 34 additions and 35 deletions

View File

@@ -472,16 +472,16 @@ public abstract class DataBufferUtils {
* Note: {@link Subscription#request(long)} happens eagerly for the first time upon subscription
* and then repeats every time {@code bufferSize - (bufferSize >> 2)} consumed.
* @param publisher the source of {@link DataBuffer} which should be represented as an {@link InputStream}
* @param bufferSize the maximum amount of {@link DataBuffer} prefetched in advance and stored inside {@link InputStream}
* @param demand the maximum number of buffers to request from the Publisher and buffer on an ongoing basis
* @return an {@link InputStream} instance representing given {@link Publisher} messages
*/
public static <T extends DataBuffer> InputStream subscribeAsInputStream(Publisher<T> publisher, int bufferSize) {
public static <T extends DataBuffer> InputStream subscriberInputStream(Publisher<T> publisher, int demand) {
Assert.notNull(publisher, "Publisher must not be null");
Assert.isTrue(bufferSize > 0, "Buffer size must be > 0");
Assert.isTrue(demand > 0, "maxBufferCount must be > 0");
InputStreamSubscriber inputStreamSubscriber = new InputStreamSubscriber(bufferSize);
publisher.subscribe(inputStreamSubscriber);
return inputStreamSubscriber;
SubscriberInputStream subscriber = new SubscriberInputStream(demand);
publisher.subscribe(subscriber);
return subscriber;
}

View File

@@ -39,13 +39,13 @@ import org.springframework.util.Assert;
* Bridges between {@link Publisher Publisher&lt;DataBuffer&gt;} and {@link InputStream}.
*
* <p>Note that this class has a near duplicate in
* {@link org.springframework.http.client.InputStreamSubscriber}.
* {@link org.springframework.http.client.SubscriberInputStream}.
*
* @author Oleh Dokuka
* @author Rossen Stoyanchev
* @since 6.2
*/
final class InputStreamSubscriber extends InputStream implements Subscriber<DataBuffer> {
final class SubscriberInputStream extends InputStream implements Subscriber<DataBuffer> {
private static final Object READY = new Object();
@@ -82,10 +82,10 @@ final class InputStreamSubscriber extends InputStream implements Subscriber<Data
private Throwable error;
InputStreamSubscriber(int prefetch) {
this.prefetch = prefetch;
this.limit = (prefetch == Integer.MAX_VALUE ? Integer.MAX_VALUE : prefetch - (prefetch >> 2));
this.queue = new ArrayBlockingQueue<>(prefetch);
SubscriberInputStream(int demand) {
this.prefetch = demand;
this.limit = (demand == Integer.MAX_VALUE ? Integer.MAX_VALUE : demand - (demand >> 2));
this.queue = new ArrayBlockingQueue<>(demand);
this.lock = new ReentrantLock(false);
}

View File

@@ -754,7 +754,7 @@ class DataBufferUtilsTests extends AbstractDataBufferAllocatingTests {
byte[] chunk = new byte[readChunkSize];
List<String> words = new ArrayList<>();
try (InputStream in = DataBufferUtils.subscribeAsInputStream(publisher, bufferSize)) {
try (InputStream in = DataBufferUtils.subscriberInputStream(publisher, bufferSize)) {
int read;
while ((read = in.read(chunk)) > -1) {
words.add(new String(chunk, 0, read, StandardCharsets.UTF_8));
@@ -791,7 +791,7 @@ class DataBufferUtilsTests extends AbstractDataBufferAllocatingTests {
byte[] chunk = new byte[4];
List<String> words = new ArrayList<>();
try (InputStream in = DataBufferUtils.subscribeAsInputStream(publisher, 1)) {
try (InputStream in = DataBufferUtils.subscriberInputStream(publisher, 1)) {
int read;
while ((read = in.read(chunk)) > -1) {
words.add(new String(chunk, 0, read, StandardCharsets.UTF_8));
@@ -830,7 +830,7 @@ class DataBufferUtilsTests extends AbstractDataBufferAllocatingTests {
byte[] chunk = new byte[3];
ArrayList<String> words = new ArrayList<>();
try (InputStream inputStream = DataBufferUtils.subscribeAsInputStream(publisher, 1)) {
try (InputStream inputStream = DataBufferUtils.subscriberInputStream(publisher, 1)) {
words.add(new String(chunk,0, inputStream.read(chunk), StandardCharsets.UTF_8));
assertThat(inputStream.read()).isEqualTo(' ' & 0xFF);
words.add(new String(chunk,0, inputStream.read(chunk), StandardCharsets.UTF_8));
@@ -874,7 +874,7 @@ class DataBufferUtilsTests extends AbstractDataBufferAllocatingTests {
byte[] chunk = new byte[3];
ArrayList<String> words = new ArrayList<>();
try (InputStream in = DataBufferUtils.subscribeAsInputStream(publisher, ThreadLocalRandom.current().nextInt(1, 4))) {
try (InputStream in = DataBufferUtils.subscriberInputStream(publisher, ThreadLocalRandom.current().nextInt(1, 4))) {
in.read(chunk);
String word = new String(chunk, StandardCharsets.UTF_8);
words.add(word);