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.
- Annotations
- @silent()
- Source
- Materializer.scala
- Alphabetic
- By Inheritance
- Materializer
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new Materializer()
Abstract Value Members
-
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.
-
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.
-
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.
-
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.
-
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.
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
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
-
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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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()
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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