Packages

abstract class ActorMaterializer extends Materializer with MaterializerLoggingProvider

An ActorMaterializer takes a stream blueprint and turns it into a running stream.

Source
ActorMaterializer.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorMaterializer
  2. MaterializerLoggingProvider
  3. Materializer
  4. AnyRef
  5. 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 ActorMaterializer()

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.

    Note that this is not necessarily the same execution context the stream operator itself is running on.

    Definition Classes
    Materializer
  2. abstract def isShutdown: Boolean

    Indicates if the materializer has been shut down.

  3. abstract def makeLogger(logSource: Class[_]): LoggingAdapter
    Definition Classes
    MaterializerLoggingProvider
  4. abstract def materialize[Mat](runnable: Graph[ClosedShape, Mat], defaultAttributes: Attributes): Mat

    This method interprets the given Flow description and creates the running stream using an explicitly provided Attributes as top level (least specific) attributes that will be defaults for the materialized stream.

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

    Definition Classes
    Materializer
  5. 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.

    Definition Classes
    Materializer
  6. abstract def scheduleOnce(delay: FiniteDuration, task: Runnable): Cancellable

    Interface for operators that need timer services for their functionality.

    Interface for operators 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.

    Definition Classes
    Materializer
  7. abstract def schedulePeriodically(initialDelay: FiniteDuration, interval: FiniteDuration, task: Runnable): Cancellable

    Interface for operators that need timer services for their functionality.

    Interface for operators 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.

    Definition Classes
    Materializer
  8. abstract def settings: ActorMaterializerSettings
  9. abstract def shutdown(): Unit

    Shuts down this materializer and all the operators that have been materialized through this materializer.

    Shuts down this materializer and all the operators that have been materialized through this materializer. After having shut down, this materializer cannot be used again. Any attempt to materialize operators after having shut down will result in an IllegalStateException being thrown at materialization time.

  10. abstract def system: ActorSystem

    INTERNAL API

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

    Definition Classes
    Materializer