Class StreamingResponseBody.PublisherBody

java.lang.Object

com.soklet.StreamingResponseBody.PublisherBody

All Implemented Interfaces:

StreamingResponseBody

Enclosing interface:

StreamingResponseBody

public static final class StreamingResponseBody.PublisherBody
extends Object
implements StreamingResponseBody

A streaming body backed by a Flow.Publisher.

Author:

Mark Allen

Nested Class Summary

Nested classes/interfaces inherited from interface StreamingResponseBody

StreamingResponseBody.InputStreamBody, StreamingResponseBody.InputStreamBuilder, StreamingResponseBody.PublisherBody, StreamingResponseBody.ReaderBody, StreamingResponseBody.ReaderBuilder, StreamingResponseBody.WriterBody

Modifier and Type	Interface	Description
static final class	StreamingResponseBody.InputStreamBody	A streaming body backed by an InputStream supplier.
static final class	StreamingResponseBody.InputStreamBuilder	Builder for input-stream-backed response bodies.
static final class	StreamingResponseBody.PublisherBody	A streaming body backed by a Flow.Publisher.
static final class	StreamingResponseBody.ReaderBody	A streaming body backed by a Reader supplier.
static final class	StreamingResponseBody.ReaderBuilder	Builder for reader-backed response bodies.
static final class	StreamingResponseBody.WriterBody	A streaming body backed by a writer callback.

Field Summary

Fields inherited from interface StreamingResponseBody

DEFAULT_INPUT_STREAM_BUFFER_SIZE_IN_BYTES, DEFAULT_MALFORMED_INPUT_ACTION, DEFAULT_READER_BUFFER_SIZE_IN_CHARACTERS, DEFAULT_UNMAPPABLE_CHARACTER_ACTION

Modifier and Type	Field	Description
static final @NonNull Integer	DEFAULT_INPUT_STREAM_BUFFER_SIZE_IN_BYTES
static final @NonNull CodingErrorAction	DEFAULT_MALFORMED_INPUT_ACTION
static final @NonNull Integer	DEFAULT_READER_BUFFER_SIZE_IN_CHARACTERS
static final @NonNull CodingErrorAction	DEFAULT_UNMAPPABLE_CHARACTER_ACTION

Method Summary

Modifier and Type	Method	Description
@NonNull Flow.Publisher<@NonNull ByteBuffer>	getPublisher()	The publisher that emits byte buffers for this response.

Methods inherited from class Object

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

Method Details

getPublisher

public @NonNull Flow.Publisher<@NonNull ByteBuffer> getPublisher()

The publisher that emits byte buffers for this response.

Returns:

the byte-buffer publisher