Package org.apache.pekko.stream

Class Attributes.NestedMaterializationCancellationPolicy

java.lang.Object
org.apache.pekko.stream.Attributes.NestedMaterializationCancellationPolicy
All Implemented Interfaces:
Attributes.Attribute, Attributes.MandatoryAttribute
Enclosing class:
Attributes
public static class Attributes.NestedMaterializationCancellationPolicy extends Object implements Attributes.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 behavior) without materializing the nested flow or wait for the nested flow to materialize and then propagate the cancellation signal through it.

This applies to pekko.stream.scaladsl.FlowOps.flatMapPrefix, pekko.stream.scaladsl.Flow.futureFlow (and derivations such as pekko.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 Attributes.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.

  • Method Details

    • propagateToNestedMaterialization

      public boolean propagateToNestedMaterialization()