StreamConverters

org.apache.pekko.stream.javadsl.StreamConverters

Converters for interacting with the blocking java.io streams APIs and Java 8 Streams

Attributes

Source
StreamConverters.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Value members

Concrete methods

def asInputStream(): Sink[ByteString, InputStream]

Creates a Sink which when materialized will return an java.io.InputStream which it is possible to read the values produced by the stream this Sink is attached to.

Creates a Sink which when materialized will return an java.io.InputStream which it is possible to read the values produced by the stream this Sink is attached to.

This method uses a default read timeout, use #inputStream(FiniteDuration) or #inputStream(java.time.Duration) to explicitly configure the timeout.

This Sink is intended for inter-operation with legacy APIs since it is inherently blocking.

You can configure the internal buffer size by using pekko.stream.ActorAttributes.

The InputStream will be closed when the stream flowing into this Sink completes, and closing the InputStream will cancel this Sink.

Attributes

Source
StreamConverters.scala
def asInputStream(readTimeout: Duration): Sink[ByteString, InputStream]

Creates a Sink which when materialized will return an java.io.InputStream which it is possible to read the values produced by the stream this Sink is attached to.

Creates a Sink which when materialized will return an java.io.InputStream which it is possible to read the values produced by the stream this Sink is attached to.

This Sink is intended for inter-operation with legacy APIs since it is inherently blocking.

You can configure the internal buffer size by using pekko.stream.ActorAttributes.

The InputStream will be closed when the stream flowing into this Sink completes, and closing the InputStream will cancel this Sink.

Value parameters

readTimeout

the max time the read operation on the materialized InputStream should block

Attributes

Source
StreamConverters.scala
def asJavaStream[T](): Sink[T, Stream[T]]

Creates a sink which materializes into Java 8 Stream that can be run to trigger demand through the sink. Elements emitted through the stream will be available for reading through the Java 8 Stream.

Creates a sink which materializes into Java 8 Stream that can be run to trigger demand through the sink. Elements emitted through the stream will be available for reading through the Java 8 Stream.

The Java 8 Stream will be ended when the stream flowing into this Sink completes, and closing the Java Stream will cancel the inflow of this Sink.

Java 8 Stream throws exception in case reactive stream failed.

Be aware that Java Stream blocks current thread while waiting on next element from downstream. As it is interacting wit blocking API the implementation runs on a separate dispatcher configured through the pekko.stream.blocking-io-dispatcher.

Attributes

Source
StreamConverters.scala
def asOutputStream(writeTimeout: Duration): Source[ByteString, OutputStream]

Creates a Source which when materialized will return an java.io.OutputStream which it is possible to write the ByteStrings to the stream this Source is attached to.

Creates a Source which when materialized will return an java.io.OutputStream which it is possible to write the ByteStrings to the stream this Source is attached to.

This Source is intended for inter-operation with legacy APIs since it is inherently blocking.

You can configure the default dispatcher for this Source by changing the pekko.stream.materializer.blocking-io-dispatcher or set it for a given Source by using pekko.stream.ActorAttributes.

The created OutputStream will be closed when the Source is cancelled, and closing the OutputStream will complete this Source.

Value parameters

writeTimeout

the max time the write operation on the materialized OutputStream should block

Attributes

Source
StreamConverters.scala
def asOutputStream(): Source[ByteString, OutputStream]

Creates a Source which when materialized will return an java.io.OutputStream which it is possible to write the ByteStrings to the stream this Source is attached to. The write timeout for OutputStreams materialized will default to 5 seconds, @see #outputStream(FiniteDuration) or #outputStream(java.time.Duration) if you want to override it.

Creates a Source which when materialized will return an java.io.OutputStream which it is possible to write the ByteStrings to the stream this Source is attached to. The write timeout for OutputStreams materialized will default to 5 seconds, @see #outputStream(FiniteDuration) or #outputStream(java.time.Duration) if you want to override it.

This Source is intended for inter-operation with legacy APIs since it is inherently blocking.

You can configure the internal buffer size by using pekko.stream.ActorAttributes.

The created OutputStream will be closed when the Source is cancelled, and closing the OutputStream will complete this Source.

Attributes

Source
StreamConverters.scala
def fromInputStream(in: Creator[InputStream], chunkSize: Int): Source[ByteString, CompletionStage[IOResult]]

Creates a Source from an java.io.InputStream created by the given function. Emitted elements are up to chunkSize sized pekko.util.ByteString elements. The actual size of the emitted elements depends on how much data the underlying java.io.InputStream returns on each read invocation. Such chunks will never be larger than chunkSize though.

Creates a Source from an java.io.InputStream created by the given function. Emitted elements are up to chunkSize sized pekko.util.ByteString elements. The actual size of the emitted elements depends on how much data the underlying java.io.InputStream returns on each read invocation. Such chunks will never be larger than chunkSize though.

You can configure the default dispatcher for this Source by changing the pekko.stream.materializer.blocking-io-dispatcher or set it for a given Source by using pekko.stream.ActorAttributes.

It materializes a CompletionStage of IOResult containing the number of bytes read from the source file upon completion, and a possible exception if IO operation was not completed successfully. Note that bytes having been read by the source does not give any guarantee that the bytes were seen by downstream stages.

The created InputStream will be closed when the Source is cancelled.

Attributes

Source
StreamConverters.scala
def fromInputStream(in: Creator[InputStream]): Source[ByteString, CompletionStage[IOResult]]

Creates a Source from an java.io.InputStream created by the given function. Emitted elements are up to 8192 bytes sized pekko.util.ByteString elements. The actual size of the emitted elements depends on how much data the underlying java.io.InputStream returns on each read invocation. Such chunks will never be larger than chunkSize though.

Creates a Source from an java.io.InputStream created by the given function. Emitted elements are up to 8192 bytes sized pekko.util.ByteString elements. The actual size of the emitted elements depends on how much data the underlying java.io.InputStream returns on each read invocation. Such chunks will never be larger than chunkSize though.

You can configure the default dispatcher for this Source by changing the pekko.stream.materializer.blocking-io-dispatcher or set it for a given Source by using pekko.stream.ActorAttributes.

It materializes a CompletionStage of IOResult containing the number of bytes read from the source file upon completion, and a possible exception if IO operation was not completed successfully.

The created InputStream will be closed when the Source is cancelled.

Attributes

Source
StreamConverters.scala
def fromJavaStream[O, S <: BaseStream[O, LazyRef(...)]](stream: Creator[BaseStream[O, S]]): Source[O, NotUsed]

Creates a source that wraps a Java 8 Stream. Source uses a stream iterator to get all its elements and send them downstream on demand.

Creates a source that wraps a Java 8 Stream. Source uses a stream iterator to get all its elements and send them downstream on demand.

Example usage: Source.fromJavaStream(() -> IntStream.rangeClosed(1, 10))

You can use Source.async to create asynchronous boundaries between synchronous java stream and the rest of flow.

Attributes

Source
StreamConverters.scala
def fromOutputStream(f: Creator[OutputStream]): Sink[ByteString, CompletionStage[IOResult]]

Sink which writes incoming ByteStrings to an OutputStream created by the given function.

Sink which writes incoming ByteStrings to an OutputStream created by the given function.

Materializes a CompletionStage of IOResult that will be completed with the size of the file (in bytes) at the streams completion, and a possible exception if IO operation was not completed successfully.

You can configure the default dispatcher for this Source by changing the pekko.stream.materializer.blocking-io-dispatcher or set it for a given Source by using pekko.stream.ActorAttributes.

This method uses no auto flush for the java.io.OutputStream @see Boolean) if you want to override it.

The OutputStream will be closed when the stream flowing into this Sink is completed. The Sink will cancel the stream when the OutputStream is no longer writable.

Value parameters

f

A Creator which creates an OutputStream to write to

Attributes

Source
StreamConverters.scala
def fromOutputStream(f: Creator[OutputStream], autoFlush: Boolean): Sink[ByteString, CompletionStage[IOResult]]

Sink which writes incoming ByteStrings to an OutputStream created by the given function.

Sink which writes incoming ByteStrings to an OutputStream created by the given function.

Materializes a CompletionStage of IOResult that will be completed with the size of the file (in bytes) at the streams completion, and a possible exception if IO operation was not completed successfully.

You can configure the default dispatcher for this Source by changing the pekko.stream.materializer.blocking-io-dispatcher or set it for a given Source by using pekko.stream.ActorAttributes.

The OutputStream will be closed when the stream flowing into this Sink is completed. The Sink will cancel the stream when the OutputStream is no longer writable.

Value parameters

autoFlush

If true the OutputStream will be flushed whenever a byte array is written

f

A Creator which creates an OutputStream to write to

Attributes

Source
StreamConverters.scala
def javaCollector[T, R](collector: Creator[Collector[T, _, R]]): Sink[T, CompletionStage[R]]

Creates a sink which materializes into a CompletionStage which will be completed with a result of the Java 8 Collector transformation and reduction operations. This allows usage of Java 8 streams transformations for reactive streams. The Collectorwill trigger demand downstream. Elements emitted through the stream will be accumulated into a mutable result container, optionally transformed into a final representation after all input elements have been processed. TheCollector`` can also do reduction at the end. Reduction processing is performed sequentially

Creates a sink which materializes into a CompletionStage which will be completed with a result of the Java 8 Collector transformation and reduction operations. This allows usage of Java 8 streams transformations for reactive streams. The Collectorwill trigger demand downstream. Elements emitted through the stream will be accumulated into a mutable result container, optionally transformed into a final representation after all input elements have been processed. TheCollector`` can also do reduction at the end. Reduction processing is performed sequentially

Note that a flow can be materialized multiple times, so the function producing the Collector must be able to handle multiple invocations.

Attributes

Source
StreamConverters.scala
def javaCollectorParallelUnordered[T, R](parallelism: Int)(collector: Creator[Collector[T, _, R]]): Sink[T, CompletionStage[R]]

Creates a sink which materializes into a CompletionStage which will be completed with a result of the Java 8 Collector transformation and reduction operations. This allows usage of Java 8 streams transformations for reactive streams. The Collector will trigger demand downstream. Elements emitted through the stream will be accumulated into a mutable result container, optionally transformed into a final representation after all input elements have been processed. Collector can also do reduction at the end. Reduction processing is performed in parallel based on graph Balance.

Creates a sink which materializes into a CompletionStage which will be completed with a result of the Java 8 Collector transformation and reduction operations. This allows usage of Java 8 streams transformations for reactive streams. The Collector will trigger demand downstream. Elements emitted through the stream will be accumulated into a mutable result container, optionally transformed into a final representation after all input elements have been processed. Collector can also do reduction at the end. Reduction processing is performed in parallel based on graph Balance.

Note that a flow can be materialized multiple times, so the function producing the Collector must be able to handle multiple invocations.

Attributes

Source
StreamConverters.scala

Deprecated methods

def asInputStream(readTimeout: FiniteDuration): Sink[ByteString, InputStream]

Creates a Sink which when materialized will return an java.io.InputStream which it is possible to read the values produced by the stream this Sink is attached to.

Creates a Sink which when materialized will return an java.io.InputStream which it is possible to read the values produced by the stream this Sink is attached to.

This Sink is intended for inter-operation with legacy APIs since it is inherently blocking.

You can configure the internal buffer size by using pekko.stream.ActorAttributes.

The InputStream will be closed when the stream flowing into this Sink completes, and closing the InputStream will cancel this Sink.

Value parameters

readTimeout

the max time the read operation on the materialized InputStream should block

Attributes

Deprecated
[Since version Akka 2.5.12]
Source
StreamConverters.scala
def asOutputStream(writeTimeout: FiniteDuration): Source[ByteString, OutputStream]

Creates a Source which when materialized will return an java.io.OutputStream which it is possible to write the ByteStrings to the stream this Source is attached to.

Creates a Source which when materialized will return an java.io.OutputStream which it is possible to write the ByteStrings to the stream this Source is attached to.

This Source is intended for inter-operation with legacy APIs since it is inherently blocking.

You can configure the internal buffer size by using pekko.stream.ActorAttributes.

The created OutputStream will be closed when the Source is cancelled, and closing the OutputStream will complete this Source.

Value parameters

writeTimeout

the max time the write operation on the materialized OutputStream should block

Attributes

Deprecated
[Since version Akka 2.5.12]
Source
StreamConverters.scala