Packages

o

akka.stream.scaladsl

StreamConverters

object StreamConverters

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

Source
StreamConverters.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StreamConverters
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def asInputStream(readTimeout: FiniteDuration = 5.seconds): Sink[ByteString, InputStream]

    Creates a Sink which when materialized will return an 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 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 default dispatcher for this Source by changing the akka.stream.blocking-io-dispatcher or set it for a given Source by using akka.stream.ActorAttributes.

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

    readTimeout

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

  2. 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.

    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 akka.stream.blocking-io-dispatcher.

  3. def asOutputStream(writeTimeout: FiniteDuration = 5.seconds): Source[ByteString, OutputStream]

    Creates a Source which when materialized will return an 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 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 akka.stream.blocking-io-dispatcher or set it for a given Source by using akka.stream.ActorAttributes.

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

    writeTimeout

    the max time the write operation on the materialized OutputStream should block, defaults to 5 seconds

  4. def fromInputStream(in: () ⇒ InputStream, chunkSize: Int = 8192): Source[ByteString, Future[IOResult]]

    Creates a Source from an InputStream created by the given function.

    Creates a Source from an InputStream created by the given function. Emitted elements are chunkSize sized akka.util.ByteString elements, except the final element, which will be up to chunkSize in size.

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

    It materializes a Future 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.

    in

    a function which creates the InputStream to read from

    chunkSize

    the size of each read operation, defaults to 8192

  5. def fromJavaStream[T, S <: BaseStream[T, S]](stream: () ⇒ BaseStream[T, S]): Source[T, NotUsed]

    Creates a source that wraps a Java 8 Stream.

    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.

  6. def fromOutputStream(out: () ⇒ OutputStream, autoFlush: Boolean = false): Sink[ByteString, Future[IOResult]]

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

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

    Materializes a Future 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 akka.stream.blocking-io-dispatcher or set it for a given Source by using akka.stream.ActorAttributes. If autoFlush is true the OutputStream will be flushed whenever a byte array is written, defaults to false.

    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.

  7. def javaCollector[T, R](collectorFactory: () ⇒ Collector[T, _, R]): Sink[T, Future[R]]

    Creates a sink which materializes into a Future which will be completed with result of the Java 8 Collector transformation and reduction operations.

    Creates a sink which materializes into a Future which will be completed with 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. The Collector 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.

  8. def javaCollectorParallelUnordered[T, R](parallelism: Int)(collectorFactory: () ⇒ Collector[T, _, R]): Sink[T, Future[R]]

    Creates a sink which materializes into a Future which will be completed with result of the Java 8 Collector transformation and reduction operations.

    Creates a sink which materializes into a Future which will be completed with 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. The 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.