Class/Object

akka.stream

ActorMaterializer

Related Docs: object ActorMaterializer | package stream

Permalink

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
Linear Supertypes
Type Hierarchy
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()

    Permalink

Abstract Value Members

  1. abstract def effectiveSettings(opAttr: Attributes): ActorMaterializerSettings

    Permalink
  2. implicit abstract def executionContext: ExecutionContextExecutor

    Permalink

    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
  3. abstract def isShutdown: Boolean

    Permalink

    Indicates if the materializer has been shut down.

  4. abstract def makeLogger(logSource: Class[_]): LoggingAdapter

    Permalink
    Definition Classes
    MaterializerLoggingProvider
  5. abstract def materialize[Mat](runnable: Graph[ClosedShape, Mat], initialAttributes: Attributes): Mat

    Permalink

    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
  6. abstract def materialize[Mat](runnable: Graph[ClosedShape, Mat]): Mat

    Permalink

    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
  7. abstract def scheduleOnce(delay: FiniteDuration, task: Runnable): Cancellable

    Permalink

    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
  8. abstract def schedulePeriodically(initialDelay: FiniteDuration, interval: FiniteDuration, task: Runnable): Cancellable

    Permalink

    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
  9. abstract def settings: ActorMaterializerSettings

    Permalink
  10. abstract def shutdown(): Unit

    Permalink

    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.

  11. abstract def system: ActorSystem

    Permalink

    INTERNAL API

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

    Permalink

    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

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    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)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (ActorMaterializer) ⇒ Boolean, msg: ⇒ Any): ActorMaterializer

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. def [B](y: B): (ActorMaterializer, B)

    Permalink
    Implicit information
    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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    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