Packages

object Attributes extends Serializable

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

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

Type Members

  1. trait Attribute extends AnyRef
  2. final case class CancellationStrategy(strategy: Strategy) extends MandatoryAttribute 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.

    Annotations
    @ApiMayChange()
  3. final case class InputBuffer(initial: Int, max: Int) extends MandatoryAttribute 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 Attribute 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 Attribute with Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply(attribute: Attribute): Attributes

    INTERNAL API

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. val asyncBoundary: Attributes
  7. 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.

    Annotations
    @ApiMayChange()
  8. 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).

    Annotations
    @ApiMayChange()
  9. 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.

    Annotations
    @ApiMayChange()
  10. 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.

    Annotations
    @ApiMayChange()
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  12. 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.

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

  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. 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.

  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. 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.

  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def logLevelDebug: LogLevel

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

  22. def logLevelError: LogLevel

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

  23. def logLevelInfo: LogLevel

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

  24. def logLevelOff: LogLevel

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

  25. def logLevelWarning: LogLevel

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

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

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

    When using this method the name is encoded with URLEncoder with UTF-8 because the name is sometimes used as part of actor name. If that is not desired the name can be added in it's raw format using .addAttributes(Attributes(Name(name))).

  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. val none: Attributes
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    AnyRef → Any
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. object AsyncBoundary extends Attribute with Product with Serializable
  38. object CancellationStrategy extends Serializable
    Annotations
    @ApiMayChange()
  39. object LogLevels extends Serializable

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped