com.ibm.cos.v2.core.async.listener

Class AsyncRequestBodyListener.NotifyingAsyncRequestBody

java.lang.Object

com.ibm.cos.v2.core.async.listener.AsyncRequestBodyListener.NotifyingAsyncRequestBody

All Implemented Interfaces:

AsyncRequestBody, SdkPublisher<ByteBuffer>, org.reactivestreams.Publisher<ByteBuffer>

Enclosing interface:

AsyncRequestBodyListener

public static final class AsyncRequestBodyListener.NotifyingAsyncRequestBody
extends Object
implements AsyncRequestBody

Method Summary

Modifier and Type	Method and Description
Optional<Long>	contentLength()
String	contentType()
SdkPublisher<AsyncRequestBody>	split(AsyncRequestBodySplitConfiguration splitConfiguration) Converts this AsyncRequestBody to a publisher of AsyncRequestBodys, each of which publishes a specific portion of the original data, based on the provided AsyncRequestBodySplitConfiguration.
SdkPublisher<AsyncRequestBody>	split(Consumer<AsyncRequestBodySplitConfiguration.Builder> splitConfiguration) This is a convenience method that passes an instance of the AsyncRequestBodySplitConfiguration builder, avoiding the need to create one manually via AsyncRequestBodySplitConfiguration.builder().
void	subscribe(org.reactivestreams.Subscriber<? super ByteBuffer> s)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.core.async.AsyncRequestBody

empty, forBlockingInputStream, forBlockingOutputStream, fromByteBuffer, fromByteBuffers, fromByteBuffersUnsafe, fromByteBufferUnsafe, fromBytes, fromBytesUnsafe, fromFile, fromFile, fromFile, fromFile, fromInputStream, fromInputStream, fromInputStream, fromPublisher, fromRemainingByteBuffer, fromRemainingByteBuffers, fromRemainingByteBuffersUnsafe, fromRemainingByteBufferUnsafe, fromString, fromString

Methods inherited from interface com.ibm.cos.v2.core.async.SdkPublisher

adapt, addTrailingData, buffer, doAfterOnCancel, doAfterOnComplete, doAfterOnError, filter, filter, flatMapIterable, fromIterable, limit, map, subscribe

Method Detail

contentLength

public Optional<Long> contentLength()

Specified by:

contentLength in interface AsyncRequestBody

Returns:

The content length of the data being produced.

contentType

public String contentType()

Specified by:

contentType in interface AsyncRequestBody

Returns:

The content type of the data being produced.

split

public SdkPublisher<AsyncRequestBody> split(AsyncRequestBodySplitConfiguration splitConfiguration)

Description copied from interface: AsyncRequestBody

Converts this AsyncRequestBody to a publisher of AsyncRequestBodys, each of which publishes a specific portion of the original data, based on the provided AsyncRequestBodySplitConfiguration. The default chunk size is 2MB and the default buffer size is 8MB.

By default, if content length of this AsyncRequestBody is present, each divided AsyncRequestBody is delivered to the subscriber right after it's initialized. On the other hand, if content length is null, it is sent after the entire content for that chunk is buffered. In this case, the configured maxMemoryUsageInBytes must be larger than or equal to chunkSizeInBytes. Note that this behavior may be different if a specific implementation of this interface overrides this method.

Specified by:

split in interface AsyncRequestBody

See Also:

AsyncRequestBodySplitConfiguration

split

public SdkPublisher<AsyncRequestBody> split(Consumer<AsyncRequestBodySplitConfiguration.Builder> splitConfiguration)

Description copied from interface: AsyncRequestBody

This is a convenience method that passes an instance of the AsyncRequestBodySplitConfiguration builder, avoiding the need to create one manually via AsyncRequestBodySplitConfiguration.builder().

Specified by:

split in interface AsyncRequestBody

See Also:

AsyncRequestBody.split(AsyncRequestBodySplitConfiguration)

subscribe

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

Specified by:

subscribe in interface org.reactivestreams.Publisher<ByteBuffer>