Package software.amazon.awssdk.utils.async

Class ByteBufferStoringSubscriber

java.lang.Object

software.amazon.awssdk.utils.async.ByteBufferStoringSubscriber

All Implemented Interfaces:

org.reactivestreams.Subscriber<ByteBuffer>

@SdkProtectedApi
public class ByteBufferStoringSubscriber
extends Object
implements org.reactivestreams.Subscriber<ByteBuffer>

An implementation of Subscriber that stores ByteBuffer events it receives for retrieval.

Stored bytes can be read via transferTo(ByteBuffer).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ByteBufferStoringSubscriber.TransferResult	The result of transferTo(ByteBuffer).

Constructor Summary

Constructors

Constructor	Description
ByteBufferStoringSubscriber(long minimumBytesBuffered)	Create a subscriber that stores at least minimumBytesBuffered in memory for retrieval.

Method Summary

Modifier and Type	Method	Description
ByteBufferStoringSubscriber.TransferResult	blockingTransferTo(ByteBuffer out)	Like transferTo(ByteBuffer), but blocks until some data has been written.
void	onComplete()
void	onError(Throwable t)
void	onNext(ByteBuffer byteBuffer)
void	onSubscribe(org.reactivestreams.Subscription s)
ByteBufferStoringSubscriber.TransferResult	transferTo(ByteBuffer out)	Transfer the data stored by this subscriber into the provided byte buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteBufferStoringSubscriber

public ByteBufferStoringSubscriber(long minimumBytesBuffered)

Create a subscriber that stores at least minimumBytesBuffered in memory for retrieval. The subscriber will only request more from the subscription when fewer bytes are buffered AND in flight requests from the subscription will likely be under minimumBytesBuffered.

Method Detail

transferTo

public ByteBufferStoringSubscriber.TransferResult transferTo(ByteBuffer out)

Transfer the data stored by this subscriber into the provided byte buffer.

If the data stored by this subscriber exceeds out's limit, then out will be filled. If the data stored by this subscriber is less than out's limit, then all stored data will be written to out.

If onError(Throwable) was called on this subscriber, as much data as is available will be transferred into out before the provided exception is thrown (as a RuntimeException).

If onComplete() was called on this subscriber, as much data as is available will be transferred into out, and this will return ByteBufferStoringSubscriber.TransferResult.END_OF_STREAM.

Note: This method MUST NOT be called concurrently with itself or blockingTransferTo(ByteBuffer). Other methods on this class may be called concurrently with this one. This MUST NOT be called before onSubscribe(Subscription) has returned.

blockingTransferTo

public ByteBufferStoringSubscriber.TransferResult blockingTransferTo(ByteBuffer out)

Like transferTo(ByteBuffer), but blocks until some data has been written.

Note: This method MUST NOT be called concurrently with itself or transferTo(ByteBuffer). Other methods on this class may be called concurrently with this one.

onSubscribe

public void onSubscribe(org.reactivestreams.Subscription s)

Specified by:

onSubscribe in interface org.reactivestreams.Subscriber<ByteBuffer>

onNext

public void onNext(ByteBuffer byteBuffer)

Specified by:

onNext in interface org.reactivestreams.Subscriber<ByteBuffer>

onError

public void onError(Throwable t)

Specified by:

onError in interface org.reactivestreams.Subscriber<ByteBuffer>

onComplete

public void onComplete()

Specified by:

onComplete in interface org.reactivestreams.Subscriber<ByteBuffer>