Packages

c

akka.stream

Materializer

abstract class Materializer extends AnyRef

Materializer SPI (Service Provider Interface)

Binary compatibility is NOT guaranteed on materializer internals.

Custom materializer implementations should be aware that the materializer SPI is not yet final and may change in patch releases of Akka. Please note that this does not impact end-users of Akka streams, only implementors of custom materializers, with whom the Akka team co-ordinates such changes.

Once the SPI is final this notice will be removed.

Source
Materializer.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
ActorMaterializer, ExtendedActorMaterializer
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Materializer
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Materializer()

Abstract Value Members

  1. implicit abstract def executionContext: ExecutionContextExecutor

    Running a flow graph will require execution resources, as will computations within Sources, Sinks, etc.

    Running a flow graph will require execution resources, as will computations within Sources, Sinks, etc. This scala.concurrent.ExecutionContextExecutor can be used by parts of the flow to submit processing jobs for execution, run Future callbacks, etc.

  2. abstract def materialize[Mat](runnable: Graph[ClosedShape, Mat], initialAttributes: Attributes): Mat

    This method interprets the given Flow description and creates the running stream using an explicitly provided Attributes as top level attributes.

    This method interprets the given Flow description and creates the running stream using an explicitly provided Attributes as top level attributes. The result can be highly implementation specific, ranging from local actor chains to remote-deployed processing networks.

  3. abstract def materialize[Mat](runnable: Graph[ClosedShape, Mat]): Mat

    This method interprets the given Flow description and creates the running stream.

    This method interprets the given Flow description and creates the running stream. The result can be highly implementation specific, ranging from local actor chains to remote-deployed processing networks.

  4. abstract def scheduleOnce(delay: FiniteDuration, task: Runnable): Cancellable

    Interface for stages that need timer services for their functionality.

    Interface for stages that need timer services for their functionality. Schedules a single task with the given delay.

    returns

    A akka.actor.Cancellable that allows cancelling the timer. Cancelling is best effort, if the event has been already enqueued it will not have an effect.

  5. abstract def schedulePeriodically(initialDelay: FiniteDuration, interval: FiniteDuration, task: Runnable): Cancellable

    Interface for stages that need timer services for their functionality.

    Interface for stages that need timer services for their functionality. Schedules a repeated task with the given interval between invocations.

    returns

    A akka.actor.Cancellable that allows cancelling the timer. Cancelling is best effort, if the event has been already enqueued it will not have an effect.

  6. abstract def withNamePrefix(name: String): Materializer

    The namePrefix shall be used for deriving the names of processing entities that are created during materialization.

    The namePrefix shall be used for deriving the names of processing entities that are created during materialization. This is meant to aid logging and failure reporting both during materialization and while the stream is running.