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

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 Materializer to any2stringadd[Materializer] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Materializer, B)
    Implicit
    This member is added by an implicit conversion from Materializer to ArrowAssoc[Materializer] 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[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Materializer) ⇒ Boolean, msg: ⇒ Any): Materializer
    Implicit
    This member is added by an implicit conversion from Materializer to Ensuring[Materializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Materializer) ⇒ Boolean): Materializer
    Implicit
    This member is added by an implicit conversion from Materializer to Ensuring[Materializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Materializer
    Implicit
    This member is added by an implicit conversion from Materializer to Ensuring[Materializer] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Materializer
    Implicit
    This member is added by an implicit conversion from Materializer to Ensuring[Materializer] 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 finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Materializer to StringFormat[Materializer] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (Materializer, B)
    Implicit
    This member is added by an implicit conversion from Materializer to ArrowAssoc[Materializer] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped