Packages

final class ActorMaterializerSettings extends AnyRef

This class describes the configurable properties of the ActorMaterializer. Please refer to the withX methods for descriptions of the individual settings.

The constructor is not public API, use create or apply on the ActorMaterializerSettings companion instead.

Source
ActorMaterializer.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ActorMaterializerSettings
  2. AnyRef
  3. 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

Instance Constructors

  1. new ActorMaterializerSettings(initialInputBufferSize: Int, maxInputBufferSize: Int, dispatcher: String, supervisionDecider: Decider, subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings, debugLogging: Boolean, outputBurstLimit: Int, fuzzingMode: Boolean, autoFusing: Boolean, maxFixedBufferSize: Int)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.10) Use ActorMaterializerSettings.apply or ActorMaterializerSettings.create instead

  2. new ActorMaterializerSettings(initialInputBufferSize: Int, maxInputBufferSize: Int, dispatcher: String, supervisionDecider: Decider, subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings, debugLogging: Boolean, outputBurstLimit: Int, fuzzingMode: Boolean, autoFusing: Boolean, maxFixedBufferSize: Int, syncProcessingLimit: Int)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.10) Use ActorMaterializerSettings.apply or ActorMaterializerSettings.create instead

  3. new ActorMaterializerSettings(initialInputBufferSize: Int, maxInputBufferSize: Int, dispatcher: String, supervisionDecider: Decider, subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings, debugLogging: Boolean, outputBurstLimit: Int, fuzzingMode: Boolean, autoFusing: Boolean, maxFixedBufferSize: Int, syncProcessingLimit: Int, ioSettings: IOSettings)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.10) Use ActorMaterializerSettings.apply or ActorMaterializerSettings.create instead

Value Members

  1. val autoFusing: Boolean
  2. val blockingIoDispatcher: String
  3. val debugLogging: Boolean
  4. val dispatcher: String
  5. def equals(other: Any): Boolean
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  6. val fuzzingMode: Boolean
  7. val initialInputBufferSize: Int
  8. val ioSettings: IOSettings
  9. val maxFixedBufferSize: Int
  10. val maxInputBufferSize: Int
  11. val outputBurstLimit: Int
  12. val streamRefSettings: StreamRefSettings
  13. val subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings
  14. val supervisionDecider: Decider
  15. val syncProcessingLimit: Int
  16. def toString(): String
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  17. def withBlockingIoDispatcher(newBlockingIoDispatcher: String): ActorMaterializerSettings
  18. def withDebugLogging(enable: Boolean): ActorMaterializerSettings

    Enable to log all elements that are dropped due to failures (at DEBUG level).

  19. def withDispatcher(dispatcher: String): ActorMaterializerSettings

    This setting configures the default dispatcher to be used by streams materialized with the ActorMaterializer.

    This setting configures the default dispatcher to be used by streams materialized with the ActorMaterializer. This can be overridden for individual parts of the stream topology by using akka.stream.Attributes#dispatcher.

  20. def withFuzzing(enable: Boolean): ActorMaterializerSettings

    Test utility: fuzzing mode means that GraphStage events are not processed in FIFO order within a fused subgraph, but randomized.

  21. def withIOSettings(ioSettings: IOSettings): ActorMaterializerSettings
  22. def withInputBuffer(initialSize: Int, maxSize: Int): ActorMaterializerSettings

    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 setting configures the default for initial and maximal input buffer in number of elements for each inlet. This can be overridden for individual parts of the stream topology by using akka.stream.Attributes#inputBuffer.

    FIXME: this is used for all kinds of buffers, not only the stream actor, some use initial some use max, document and or fix if it should not be like that. Search for get[Attributes.InputBuffer] to see how it is used

  23. def withMaxFixedBufferSize(size: Int): ActorMaterializerSettings

    Configure the maximum buffer size for which a FixedSizeBuffer will be preallocated.

    Configure the maximum buffer size for which a FixedSizeBuffer will be preallocated. This defaults to a large value because it is usually better to fail early when system memory is not sufficient to hold the buffer.

  24. def withOutputBurstLimit(limit: Int): ActorMaterializerSettings

    Maximum number of elements emitted in batch if downstream signals large demand.

  25. def withStreamRefSettings(streamRefSettings: StreamRefSettings): ActorMaterializerSettings

    Change settings specific to SourceRef and SinkRef.

  26. def withSubscriptionTimeoutSettings(settings: StreamSubscriptionTimeoutSettings): ActorMaterializerSettings

    Leaked publishers and subscribers are cleaned up when they are not used within a given deadline, configured by StreamSubscriptionTimeoutSettings.

  27. def withSupervisionStrategy(decider: Function[Throwable, Directive]): ActorMaterializerSettings

    Java API: Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with akka.stream.Attributes#supervisionStrategy.

    Java API: Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with akka.stream.Attributes#supervisionStrategy.

    Note that supervision in streams are implemented on a per operator basis and is not supported by every operator.

  28. def withSupervisionStrategy(decider: Decider): ActorMaterializerSettings

    Scala API: Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with akka.stream.Attributes#supervisionStrategy.

    Scala API: Decides how exceptions from application code are to be handled, unless overridden for specific flows of the stream operations with akka.stream.Attributes#supervisionStrategy.

    Note that supervision in streams are implemented on a per operator basis and is not supported by every operator.

  29. def withSyncProcessingLimit(limit: Int): ActorMaterializerSettings

    Limit for number of messages that can be processed synchronously in stream to substream communication

Deprecated Value Members

  1. def withAutoFusing(enable: Boolean): ActorMaterializerSettings

    Enable automatic fusing of all graphs that are run.

    Enable automatic fusing of all graphs that are run. For short-lived streams this may cause an initial runtime overhead, but most of the time fusing is desirable since it reduces the number of Actors that are created.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.0) Turning off fusing is no longer possible with the traversal based materializer