abstract class ActorMaterializer extends Materializer with MaterializerLoggingProvider
An ActorMaterializer takes the list of transformations comprising a akka.stream.scaladsl.Flow and materializes them in the form of org.reactivestreams.Processor instances. How transformation steps are split up into asynchronous regions is implementation dependent.
- Source
- ActorMaterializer.scala
- Alphabetic
- By Inheritance
- ActorMaterializer
- MaterializerLoggingProvider
- Materializer
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ActorMaterializer()
Abstract Value Members
- abstract def effectiveSettings(opAttr: Attributes): ActorMaterializerSettings
-
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.
- Definition Classes
- Materializer
-
abstract
def
isShutdown: Boolean
Indicates if the materializer has been shut down.
-
abstract
def
makeLogger(logSource: Class[_]): LoggingAdapter
- Definition Classes
- MaterializerLoggingProvider
-
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.
- Definition Classes
- Materializer
-
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
-
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.
- Definition Classes
- Materializer
-
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.
- Definition Classes
- Materializer
- abstract def settings: ActorMaterializerSettings
-
abstract
def
shutdown(): Unit
Shuts down this materializer and all the stages that have been materialized through this materializer.
Shuts down this materializer and all the stages that have been materialized through this materializer. After having shut down, this materializer cannot be used again. Any attempt to materialize stages after having shut down will result in an IllegalStateException being thrown at materialization time.
-
abstract
def
system: ActorSystem
INTERNAL API
-
abstract
def
withNamePrefix(name: String): Materializer
The
namePrefixshall be used for deriving the names of processing entities that are created during materialization.The
namePrefixshall 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