software.amazon.awssdk.http.crt.internal

Class AwsCrtResponseBodyPublisher

java.lang.Object

software.amazon.awssdk.http.crt.internal.AwsCrtResponseBodyPublisher

All Implemented Interfaces:

org.reactivestreams.Publisher<ByteBuffer>

public final class AwsCrtResponseBodyPublisher
extends Object
implements org.reactivestreams.Publisher<ByteBuffer>

Adapts an AWS Common Runtime Response Body stream from CrtHttpStreamHandler to a Publisher

Constructor Summary

Constructors

Constructor and Description
AwsCrtResponseBodyPublisher(software.amazon.awssdk.crt.http.HttpClientConnection connection, software.amazon.awssdk.crt.http.HttpStream stream, CompletableFuture<Void> responseComplete, int windowSize) Adapts a streaming AWS CRT Http Response Body to a Publisher

Method Summary

Modifier and Type	Method and Description
protected void	completeSubscriptionExactlyOnce() Completes the Subscription by calling either the .onError() or .onComplete() callbacks exactly once.
protected void	publishToSubscribers() Publishes any queued data to any Subscribers if there is data queued and there is an outstanding Subscriber request for more data.
void	queueBuffer(byte[] buffer) Adds a Buffer to the Queue to be published to any Subscribers
protected void	request(long n) Function called by Response Body Subscribers to request more Response Body buffers.
protected void	setCancelled()
void	setError(Throwable t)
void	setQueueComplete() Called when the final Buffer has been queued and no more data is expected.
void	subscribe(org.reactivestreams.Subscriber<? super ByteBuffer> subscriber) Method for the users consuming the Http Response Body to register a subscriber.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AwsCrtResponseBodyPublisher

public AwsCrtResponseBodyPublisher(software.amazon.awssdk.crt.http.HttpClientConnection connection,
                                   software.amazon.awssdk.crt.http.HttpStream stream,
                                   CompletableFuture<Void> responseComplete,
                                   int windowSize)

Adapts a streaming AWS CRT Http Response Body to a Publisher

Parameters:

stream - The AWS CRT Http Stream for this Response

windowSize - The max allowed bytes to be queued. The sum of the sizes of all queued ByteBuffers should never exceed this value.

Method Detail

subscribe

public void subscribe(org.reactivestreams.Subscriber<? super ByteBuffer> subscriber)

Method for the users consuming the Http Response Body to register a subscriber.

Specified by:

subscribe in interface org.reactivestreams.Publisher<ByteBuffer>

Parameters:

subscriber - The Subscriber to register.

queueBuffer

public void queueBuffer(byte[] buffer)

Adds a Buffer to the Queue to be published to any Subscribers

Parameters:

buffer - The Buffer to be queued.

request

protected void request(long n)

Function called by Response Body Subscribers to request more Response Body buffers.

Parameters:

n - The number of buffers requested.

setError

public void setError(Throwable t)

setCancelled

protected void setCancelled()

setQueueComplete

public void setQueueComplete()

Called when the final Buffer has been queued and no more data is expected.

completeSubscriptionExactlyOnce

protected void completeSubscriptionExactlyOnce()

Completes the Subscription by calling either the .onError() or .onComplete() callbacks exactly once.

publishToSubscribers

protected void publishToSubscribers()

Publishes any queued data to any Subscribers if there is data queued and there is an outstanding Subscriber request for more data. Will also call onError() or onComplete() callbacks if needed. This method MUST be synchronized since it can be called simultaneously from both the Native EventLoop Thread and the User Thread. If this method wasn't synchronized, it'd be possible for each thread to dequeue a buffer by calling queuedBuffers.poll(), but then have the 2nd thread call subscriber.onNext(buffer) first, resulting in the subscriber seeing out-of-order data. To avoid this race condition, this method must be synchronized.