Packages

abstract class ActorMaterializer extends Materializer with MaterializerLoggingProvider

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

Annotations
@deprecated
Deprecated

(Since version 2.6.0) The Materializer now has all methods the ActorMaterializer used to have

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.

    Indicates if the materializer has been shut down.

    Definition Classes
    ActorMaterializerMaterializer
  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 scheduleAtFixedRate(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 Runnable to be run repeatedly with an initial delay and a frequency. E.g. if you would like the function to be run after 2 seconds and thereafter every 100ms you would set delay=Duration(2, TimeUnit.SECONDS) and interval=Duration(100, TimeUnit.MILLISECONDS).

    It will compensate the delay for a subsequent task if the previous tasks took too long to execute. In such cases, the actual execution interval will differ from the interval passed to the method.

    If the execution of the tasks takes longer than the interval, the subsequent execution will start immediately after the prior one completes (there will be no overlap of executions). This also has the consequence that after long garbage collection pauses or other reasons when the JVM was suspended all "missed" tasks will execute when the process wakes up again.

    In the long run, the frequency of execution will be exactly the reciprocal of the specified interval.

    Warning: scheduleAtFixedRate can result in bursts of scheduled tasks after long garbage collection pauses, which may in worst case cause undesired load on the system. Therefore scheduleWithFixedDelay is often preferred.

    If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

    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
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum supported by the Scheduler.

  7. 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
  8. abstract def scheduleWithFixedDelay(initialDelay: FiniteDuration, 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 Runnable to be run repeatedly with an initial delay and a fixed delay between subsequent executions.

    It will not compensate the delay between tasks if the execution takes a long time or if scheduling is delayed longer than specified for some reason. The delay between subsequent execution will always be (at least) the given delay. In the long run, the frequency of execution will generally be slightly lower than the reciprocal of the specified delay.

    If the Runnable throws an exception the repeated scheduling is aborted, i.e. the function will not be invoked any more.

    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
    Exceptions thrown

    IllegalArgumentException if the given delays exceed the maximum supported by the Scheduler.

  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.

    Definition Classes
    ActorMaterializerMaterializer
  10. abstract def system: ActorSystem

    INTERNAL API

    INTERNAL API

    Definition Classes
    ActorMaterializerMaterializer
  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
  12. 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
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0)

  13. abstract def settings: ActorMaterializerSettings
    Definition Classes
    ActorMaterializerMaterializer
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attributes to access settings from stages, see https://doc.akka.io/docs/akka/2.6/project/migration-guide-2.5.x-2.6.x.html

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ActorMaterializer to any2stringadd[ActorMaterializer] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ActorMaterializer, B)
    Implicit
    This member is added by an implicit conversion from ActorMaterializer to ArrowAssoc[ActorMaterializer] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (ActorMaterializer) ⇒ Boolean, msg: ⇒ Any): ActorMaterializer
    Implicit
    This member is added by an implicit conversion from ActorMaterializer to Ensuring[ActorMaterializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ActorMaterializer) ⇒ Boolean): ActorMaterializer
    Implicit
    This member is added by an implicit conversion from ActorMaterializer to Ensuring[ActorMaterializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ActorMaterializer
    Implicit
    This member is added by an implicit conversion from ActorMaterializer to Ensuring[ActorMaterializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ActorMaterializer
    Implicit
    This member is added by an implicit conversion from ActorMaterializer to Ensuring[ActorMaterializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ActorMaterializer to StringFormat[ActorMaterializer] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def [B](y: B): (ActorMaterializer, B)
    Implicit
    This member is added by an implicit conversion from ActorMaterializer to ArrowAssoc[ActorMaterializer] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Materializer

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorMaterializer to any2stringadd[ActorMaterializer]

Inherited by implicit conversion StringFormat from ActorMaterializer to StringFormat[ActorMaterializer]

Inherited by implicit conversion Ensuring from ActorMaterializer to Ensuring[ActorMaterializer]

Inherited by implicit conversion ArrowAssoc from ActorMaterializer to ArrowAssoc[ActorMaterializer]

Ungrouped