object Attributes extends Serializable
Note that more attributes for the ActorMaterializer are defined in ActorAttributes.
- Source
- Attributes.scala
- Alphabetic
- By Inheritance
- Attributes
- Serializable
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- trait Attribute extends AnyRef
-
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 callcancelStage
which shuts down the stage completely. The given strategy will allow customization of how the shutdown procedure should be done precisely.- Annotations
- @ApiMayChange()
- final case class InputBuffer(initial: Int, max: Int) extends MandatoryAttribute with Product with Serializable
- final case class LogLevels(onElement: LogLevel, onFinish: LogLevel, onFailure: LogLevel) extends Attribute with Product with Serializable
- sealed trait MandatoryAttribute extends Attribute
- final case class Name(n: String) extends Attribute with Product with Serializable
Value Members
-
def
apply(attribute: Attribute): Attributes
INTERNAL API
- val asyncBoundary: Attributes
-
def
cancellationStrategyAfterDelay(delay: FiniteDuration, strategy: Strategy): Strategy
Strategy that allows to delay any action when
cancelStage
is invoked.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()
-
def
cancellationStrategyCompleteState: Strategy
Strategy that treats
cancelStage
the same ascompleteStage
, i.e.Strategy that treats
cancelStage
the same ascompleteStage
, i.e. all inlets are cancelled 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()
-
def
cancellationStrategyFailStage: Strategy
Strategy that treats
cancelStage
the same asfailStage
, i.e.Strategy that treats
cancelStage
the same asfailStage
, i.e. all inlets are cancelled (propagating the cancellation cause) and all outlets are failed with an SiblingDownstreamWasCancelled exception.- Annotations
- @ApiMayChange()
-
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. -
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. -
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.
-
def
inputBuffer(initial: Int, max: Int): Attributes
Specifies the initial and maximum size of the input buffer.
-
def
logLevelDebug: LogLevel
Use to enable logging at DEBUG level for certain operations when configuring Attributes#createLogLevels
-
def
logLevelError: LogLevel
Use to enable logging at ERROR level for certain operations when configuring Attributes#createLogLevels
-
def
logLevelInfo: LogLevel
Use to enable logging at INFO level for certain operations when configuring Attributes#createLogLevels
-
def
logLevelOff: LogLevel
Java API: Use to disable logging on certain operations when configuring Attributes#createLogLevels
-
def
logLevelWarning: LogLevel
Use to enable logging at WARNING level for certain operations when configuring Attributes#createLogLevels
-
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
-
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)))
. - val none: Attributes
- object AsyncBoundary extends Attribute with Product with Serializable
-
object
CancellationStrategy extends Serializable
- Annotations
- @ApiMayChange()
- object LogLevels extends Serializable