Module io.helidon.common.reactive

Package io.helidon.common.reactive

Interface IoMulti

public interface IoMulti

Create reactive stream from standard IO resources.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IoMulti.MultiFromByteChannelBuilder	Fluent API builder for creating a Multi from a ReadableByteChannel.
static class	IoMulti.MultiFromInputStreamBuilder	Fluent API builder for creating a Multi from an InputStream.
static class	IoMulti.MultiToByteChannelBuilder	Fluent API builder for creating a subscriber consuming Multi<ByteBuffer> to WritableByteChannel.
static class	IoMulti.OutputStreamMultiBuilder	Fluent API builder for OutputStreamMulti.

Method Summary

Modifier and Type	Method	Description
static IoMulti.MultiFromInputStreamBuilder	builderInputStream(InputStream inputStream)	Deprecated, for removal: This API element is subject to removal in a future version. Please use multiFromStreamBuilder(java.io.InputStream)
static IoMulti.OutputStreamMultiBuilder	builderOutputStream()	Deprecated, for removal: This API element is subject to removal in a future version. Please use outputStreamMultiBuilder()
static Multi<ByteBuffer>	createInputStream(InputStream inputStream)	Deprecated, for removal: This API element is subject to removal in a future version. please use multiFromStream(java.io.InputStream)
static OutputStreamMulti	createOutputStream()	Deprecated, for removal: This API element is subject to removal in a future version. Please use outputStreamMulti()
static Multi<ByteBuffer>	multiFromByteChannel(ReadableByteChannel byteChannel)	Creates a multi that reads data from the provided byte channel.
static IoMulti.MultiFromByteChannelBuilder	multiFromByteChannelBuilder(ReadableByteChannel byteChannel)	Creates a builder of Multi from provided ReadableByteChannel.
static Multi<ByteBuffer>	multiFromStream(InputStream inputStream)	Create a Multi instance that publishes ByteBuffers from the given InputStream.
static IoMulti.MultiFromInputStreamBuilder	multiFromStreamBuilder(InputStream inputStream)	Creates a builder of the Multi from supplied InputStream.
static Function<? super Multi<ByteBuffer>,? extends Single<Void>>	multiToByteChannel(WritableByteChannel writableChannel)	Creates function consuming Multi<ByteBuffer> to supplied WritableByteChannel.
static IoMulti.MultiToByteChannelBuilder	multiToByteChannelBuilder(WritableByteChannel byteChannel)	Creates function consuming Multi<ByteBuffer> to supplied WritableByteChannel.
static OutputStreamMulti	outputStreamMulti()	Create an OutputStream that provides the data written as a Multi.
static IoMulti.OutputStreamMultiBuilder	outputStreamMultiBuilder()	Creates a builder of the OutputStream that provides data written as a Multi.
static IoMulti.MultiToByteChannelBuilder	writeToFile(Path filePath)	Creates function consuming Multi<ByteBuffer> to FileChannel opened from supplied Path.

Method Detail

createOutputStream

@Deprecated(since="2.0.0",
            forRemoval=true)
static OutputStreamMulti createOutputStream()

Deprecated, for removal: This API element is subject to removal in a future version.

Please use outputStreamMulti()

Create an OutputStream that provides the data written as a Multi.

In case there is no demand, OutputStream.write(byte[], int, int) methods are blocked until downstream request for more data.

Returns:

new Multi publisher extending OutputStream

outputStreamMulti

static OutputStreamMulti outputStreamMulti()

Create an OutputStream that provides the data written as a Multi.

In case there is no demand, OutputStream.write(byte[], int, int) methods are blocked until downstream request for more data.

Returns:

new OutputStream implementing Multi

builderOutputStream

@Deprecated(since="2.0.0",
            forRemoval=true)
static IoMulti.OutputStreamMultiBuilder builderOutputStream()

Deprecated, for removal: This API element is subject to removal in a future version.

Please use outputStreamMultiBuilder()

Creates a builder of the OutputStream that provides data written as a Multi.

Returns:

the builder

See Also:

outputStreamMulti()

outputStreamMultiBuilder

static IoMulti.OutputStreamMultiBuilder outputStreamMultiBuilder()

Creates a builder of the OutputStream that provides data written as a Multi.

Returns:

the builder

See Also:

outputStreamMulti()

createInputStream

@Deprecated(since="2.0.0",
            forRemoval=true)
static Multi<ByteBuffer> createInputStream(InputStream inputStream)

Deprecated, for removal: This API element is subject to removal in a future version.

please use multiFromStream(java.io.InputStream)

Create a Multi instance that publishes ByteBuffers from the given InputStream.

InputStream is trusted not to block on read operations, in case it can't be assured use builder to specify executor for asynchronous waiting for blocking reads. IoMulti.builder(is).executor(executorService).build().

Parameters:

inputStream - the Stream to publish

Returns:

Multi

Throws:

NullPointerException - if stream is null

multiFromStream

static Multi<ByteBuffer> multiFromStream(InputStream inputStream)

Create a Multi instance that publishes ByteBuffers from the given InputStream.

InputStream is trusted not to block on read operations, in case it can't be assured use builder to specify executor for asynchronous waiting for blocking reads. IoMulti.builder(is).executor(executorService).build().

Parameters:

inputStream - the Stream to publish

Returns:

Multi

builderInputStream

@Deprecated(since="2.0.0",
            forRemoval=true)
static IoMulti.MultiFromInputStreamBuilder builderInputStream(InputStream inputStream)

Deprecated, for removal: This API element is subject to removal in a future version.

Please use multiFromStreamBuilder(java.io.InputStream)

Creates a builder of the Multi from supplied InputStream.

Parameters:

inputStream - the Stream to publish

Returns:

the builder

multiFromStreamBuilder

static IoMulti.MultiFromInputStreamBuilder multiFromStreamBuilder(InputStream inputStream)

Creates a builder of the Multi from supplied InputStream.

Parameters:

inputStream - the Stream to publish

Returns:

the builder

multiFromByteChannel

static Multi<ByteBuffer> multiFromByteChannel(ReadableByteChannel byteChannel)

Creates a multi that reads data from the provided byte channel. The multi uses an executor service to process asynchronous reads. You can provide a custom executor service using multiFromByteChannelBuilder(java.nio.channels.ReadableByteChannel).

Parameters:

byteChannel - readable byte channel with data

Returns:

publisher of data from the provided channel

multiToByteChannel

static Function<? super Multi<ByteBuffer>,? extends Single<Void>> multiToByteChannel(WritableByteChannel writableChannel)

Creates function consuming Multi<ByteBuffer> to supplied WritableByteChannel.
Example usage:

 Multi.create(listOfByteBuffers)
      .map(s -> ByteBuffer.wrap(s.getBytes(StandardCharsets.UTF_8)))
      .to(IoMulti.multiToByteChannel(fileChannel))
      .await();
 

Parameters:

writableChannel - for consuming ByteBuffers from upstream

Returns:

mapper consuming Multi<ByteBuffer> and returning Single for observing asynchronous writing.

multiToByteChannelBuilder

static IoMulti.MultiToByteChannelBuilder multiToByteChannelBuilder(WritableByteChannel byteChannel)

Creates function consuming Multi<ByteBuffer> to supplied WritableByteChannel.
Example usage:

 Multi.create(listOfByteBuffers)
      .map(s -> ByteBuffer.wrap(s.getBytes(StandardCharsets.UTF_8)))
      .to(IoMulti.multiToByteChannelBuilder(fileChannel)
              .executor(customExecutor)
              .build())
      .await();
 

Parameters:

byteChannel - for consuming ByteBuffers from upstream

Returns:

mapper consuming Multi<ByteBuffer> and returning Single for observing asynchronous writing.

writeToFile

static IoMulti.MultiToByteChannelBuilder writeToFile(Path filePath)

Creates function consuming Multi<ByteBuffer> to FileChannel opened from supplied Path.
Example usage:

 Multi.create(listOfByteBuffers)
      .map(s -> ByteBuffer.wrap(s.getBytes(StandardCharsets.UTF_8)))
      .to(IoMulti.writeToFile(path)
              .executor(customExecutor)
              .build())
      .await();
 

Parameters:

filePath - file for writing all ByteBuffers from upstream to

Returns:

mapper consuming Multi<ByteBuffer> and returning Single for observing asynchronous writing.

multiFromByteChannelBuilder

static IoMulti.MultiFromByteChannelBuilder multiFromByteChannelBuilder(ReadableByteChannel byteChannel)

Creates a builder of Multi from provided ReadableByteChannel.

Parameters:

byteChannel - readable byte channel with data

Returns:

fluent API builder to configure additional details