Packages

class NestedMaterializationCancellationPolicy extends MandatoryAttribute

Nested materialization cancellation strategy provides a way to configure the cancellation behavior of stages that materialize a nested flow.

When cancelled before materializing their nested flows, these stages can either immediately cancel (default behaviour) without materializing the nested flow or wait for the nested flow to materialize and then propagate the cancellation signal through it.

This applies to akka.stream.scaladsl.FlowOps.flatMapPrefix, akka.stream.scaladsl.Flow.futureFlow (and derivations such as akka.stream.scaladsl.Flow.lazyFutureFlow). These operators either delay the nested flow's materialization or wait for a future to complete before doing so, in this period of time they may receive a downstream cancellation signal. When this happens these operators will behave according to this Attribute: when set to true they will 'stash' the signal and later deliver it to the materialized nested flow , otherwise these stages will immediately cancel without materializing the nested flow.

Annotations
@ApiMayChange()
Source
Attributes.scala
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NestedMaterializationCancellationPolicy
  2. MandatoryAttribute
  3. Attribute
  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

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 NestedMaterializationCancellationPolicy toany2stringadd[NestedMaterializationCancellationPolicy] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NestedMaterializationCancellationPolicy, B)
    Implicit
    This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toArrowAssoc[NestedMaterializationCancellationPolicy] 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(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (NestedMaterializationCancellationPolicy) => Boolean, msg: => Any): NestedMaterializationCancellationPolicy
    Implicit
    This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toEnsuring[NestedMaterializationCancellationPolicy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (NestedMaterializationCancellationPolicy) => Boolean): NestedMaterializationCancellationPolicy
    Implicit
    This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toEnsuring[NestedMaterializationCancellationPolicy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): NestedMaterializationCancellationPolicy
    Implicit
    This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toEnsuring[NestedMaterializationCancellationPolicy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): NestedMaterializationCancellationPolicy
    Implicit
    This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toEnsuring[NestedMaterializationCancellationPolicy] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toStringFormat[NestedMaterializationCancellationPolicy] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_ <: AnyRef]
    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. val propagateToNestedMaterialization: Boolean
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (NestedMaterializationCancellationPolicy, B)
    Implicit
    This member is added by an implicit conversion from NestedMaterializationCancellationPolicy toArrowAssoc[NestedMaterializationCancellationPolicy] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from MandatoryAttribute

Inherited from Attribute

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromNestedMaterializationCancellationPolicy to any2stringadd[NestedMaterializationCancellationPolicy]

Inherited by implicit conversion StringFormat fromNestedMaterializationCancellationPolicy to StringFormat[NestedMaterializationCancellationPolicy]

Inherited by implicit conversion Ensuring fromNestedMaterializationCancellationPolicy to Ensuring[NestedMaterializationCancellationPolicy]

Inherited by implicit conversion ArrowAssoc fromNestedMaterializationCancellationPolicy to ArrowAssoc[NestedMaterializationCancellationPolicy]

Ungrouped