object Attributes extends Serializable

Note that more attributes for the Materializer are defined in ActorAttributes.

Source
Attributes.scala
Linear Supertypes
Serializable, AnyRef, Any
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Attributes
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait Attribute extends AnyRef
  2. final case class CancellationStrategy(strategy: Strategy) extends with Product with Serializable

    Cancellation strategies provide a way to configure the behavior of a stage when cancelStage is called.

    Cancellation strategies provide a way to configure the behavior of a stage when cancelStage is called.

    It is only relevant for stream components that have more than one output and do not define a custom cancellation behavior by overriding onDownstreamFinish. In those cases, if the first output is cancelled, the default behavior is to call cancelStage which shuts down the stage completely. The given strategy will allow customization of how the shutdown procedure should be done precisely.

  3. final case class InputBuffer(initial: Int, max: Int) extends with Product with Serializable

    Each asynchronous piece of a materialized stream topology is executed by one Actor that manages an input buffer for all inlets of its shape.

    Each asynchronous piece of a materialized stream topology is executed by one Actor that manages an input buffer for all inlets of its shape. This attribute configures the initial and maximal input buffer in number of elements for each inlet.

    Use factory method Attributes#inputBuffer to create instances.

  4. final case class LogLevels(onElement: LogLevel, onFinish: LogLevel, onFailure: LogLevel) extends with Product with Serializable
  5. sealed trait MandatoryAttribute extends Attribute

    Attributes that are always present (is defined with default values by the materializer)

    Attributes that are always present (is defined with default values by the materializer)

    Not for user extension

    Annotations
    @DoNotInherit()
  6. final case class Name(n: String) extends with Product with Serializable
  7. final class NestedMaterializationCancellationPolicy extends MandatoryAttribute

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

    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 , (and derivations such as ). 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.

  8. final class SourceLocation extends Attribute

    Attribute that contains the source location of for example a lambda passed to an operator, useful for example for debugging.

    Attribute that contains the source location of for example a lambda passed to an operator, useful for example for debugging. Included in the default toString of GraphStageLogic if present

Value Members

  1. def apply(attribute: Attribute): Attributes

    INTERNAL API

  2. def apply(attributeList: List[Attribute] = Nil): Attributes
    Annotations
    @nowarn()
  3. def apply(): Attributes
  4. val asyncBoundary: Attributes
  5. def cancellationStrategyAfterDelay(delay: FiniteDuration, strategy: Strategy): Strategy

    Java API

    Java API

    Strategy that allows to delay any action when cancelStage is invoked.

    The idea of this strategy is to delay any action on cancellation because it is expected that the stage is completed through another path in the meantime. The downside is that a stage and a stream may live longer than expected if no such signal is received and cancellation is invoked later on. In streams with many stages that all apply this strategy, this strategy might significantly delay the propagation of a cancellation signal because each upstream stage might impose such a delay. During this time, the stream will be mostly "silent", i.e. it cannot make progress because of backpressure, but you might still be able observe a long delay at the ultimate source.

  6. def cancellationStrategyCompleteState: Strategy

    Java API

    Java API

    Strategy that treats cancelStage the same as completeStage, i.e. all inlets are cancelled (propagating the cancellation cause) and all outlets are regularly completed.

    This used to be the default behavior before Akka 2.6.

    This behavior can be problematic in stacks of BidiFlows where different layers of the stack are both connected through inputs and outputs. In this case, an error in a doubly connected component triggers both a cancellation going upstream and an error going downstream. Since the stack might be connected to those components with inlets and outlets, a race starts whether the cancellation or the error arrives first. If the error arrives first, that's usually good because then the error can be propagated both on inlets and outlets. However, if the cancellation arrives first, the previous default behavior to complete the stage will lead other outputs to be completed regularly. The error which arrive late at the other hand will just be ignored (that connection will have been cancelled already and also the paths through which the error could propagates are already shut down).

  7. def cancellationStrategyFailStage: Strategy

    Java API

    Java API

    Strategy that treats cancelStage the same as failStage, i.e. all inlets are cancelled (propagating the cancellation cause) and all outlets are failed propagating the cause from cancellation.

  8. def cancellationStrategyPropagateFailure: Strategy

    Java API

    Java API

    Strategy that treats cancelStage in different ways depending on the cause that was given to the cancellation.

    If the cause was a regular, active cancellation (SubscriptionWithCancelException.NoMoreElementsNeeded), the stage receiving this cancellation is completed regularly.

    If another cause was given, this is treated as an error and the behavior is the same as with failStage.

    This is a good default strategy.

  9. def createLogLevels(onElement: LogLevel): Attributes

    Java API

    Java API

    Configures log() operator log-levels to be used when logging onElement. Logging a certain operation can be completely disabled by using Attributes#logLevelOff.

  10. def createLogLevels(onElement: LogLevel, onFinish: LogLevel, onFailure: LogLevel): Attributes

    Java API

    Java API

    Configures log() operator log-levels to be used when logging. Logging a certain operation can be completely disabled by using Attributes#logLevelOff.

  11. def extractName(builder: TraversalBuilder, default: String): String

    Compute a name by concatenating all Name attributes that the given module has, returning the given default value if none are found.

  12. def inputBuffer(initial: Int, max: Int): Attributes

    Each asynchronous piece of a materialized stream topology is executed by one Actor that manages an input buffer for all inlets of its shape.

    Each asynchronous piece of a materialized stream topology is executed by one Actor that manages an input buffer for all inlets of its shape. This attribute configures the initial and maximal input buffer in number of elements for each inlet.

  13. def logLevelDebug: LogLevel

    Java API: Use to enable logging at DEBUG level for certain operations when configuring Attributes#createLogLevels

  14. def logLevelError: LogLevel

    Java API: Use to enable logging at ERROR level for certain operations when configuring Attributes#createLogLevels

  15. def logLevelInfo: LogLevel

    Java API: Use to enable logging at INFO level for certain operations when configuring Attributes#createLogLevels

  16. def logLevelOff: LogLevel

    Java API: Use to disable logging on certain operations when configuring Attributes#createLogLevels

  17. def logLevelWarning: LogLevel

    Java API: Use to enable logging at WARNING level for certain operations when configuring Attributes#createLogLevels

  18. def logLevels(onElement: LogLevel = Logging.DebugLevel, onFinish: LogLevel = Logging.DebugLevel, onFailure: LogLevel = Logging.ErrorLevel): Attributes

    Configures log() operator log-levels to be used when logging.

    Configures log() operator log-levels to be used when logging. Logging a certain operation can be completely disabled by using LogLevels.Off.

    See Attributes.createLogLevels for Java API

  19. def name(name: String): Attributes

    Specifies the name of the operation.

    Specifies the name of the operation. If the name is null or empty the name is ignored, i.e. #none is returned.

  20. def nestedMaterializationCancellationPolicyDefault(): NestedMaterializationCancellationPolicy

    Default NestedMaterializationCancellationPolicy, please see akka.stream.Attributes#nestedMaterializationCancellationPolicyEagerCancellation() for details.

  21. def nestedMaterializationCancellationPolicyEagerCancellation(): NestedMaterializationCancellationPolicy

    Java API A NestedMaterializationCancellationPolicy that configures graph stages delaying nested flow materialization to cancel immediately when downstream cancels before nested flow materialization.

    Java API A that configures graph stages delaying nested flow materialization to cancel immediately when downstream cancels before nested flow materialization. This applies to , akka.stream.scaladsl.Flow.futureFlow and derived operators.

  22. def nestedMaterializationCancellationPolicyPropagateToNested(): NestedMaterializationCancellationPolicy

    Java API A NestedMaterializationCancellationPolicy that configures graph stages delaying nested flow materialization to delay cancellation when downstream cancels before nested flow materialization.

    Java API A that configures graph stages delaying nested flow materialization to delay cancellation when downstream cancels before nested flow materialization. Once the nested flow is materialized it will be cancelled immediately. This applies to , akka.stream.scaladsl.Flow.futureFlow and derived operators.

  23. val none: Attributes
  24. case object AsyncBoundary extends with Product with Serializable
  25. object CancellationStrategy extends Serializable
  26. object LogLevels extends Serializable
  27. object NestedMaterializationCancellationPolicy
  28. object SourceLocation

Deprecated Value Members

  1. def unapply(attrs: Attributes): Option[List[Attribute]]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) Use explicit methods on Attributes to interact, not the synthetic case class ones