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.

Source
ActorMaterializer.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
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)

Value Members

  1. val autoFusing: Boolean
  2. val debugLogging: Boolean
  3. val dispatcher: String
  4. def equals(other: Any): Boolean
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  5. val fuzzingMode: Boolean
  6. val initialInputBufferSize: Int
  7. val maxFixedBufferSize: Int
  8. val maxInputBufferSize: Int
  9. val outputBurstLimit: Int
  10. val subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings
  11. val supervisionDecider: Decider
  12. val syncProcessingLimit: Int
  13. def toString(): String
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  14. 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.

  15. def withDebugLogging(enable: Boolean): ActorMaterializerSettings

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

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

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

  18. 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 initial and maximal input buffer in number of elements for each inlet.

    FIXME: Currently only the initialSize is used, auto-tuning is not yet implemented.

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

  20. def withOutputBurstLimit(limit: Int): ActorMaterializerSettings

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

  21. def withSubscriptionTimeoutSettings(settings: StreamSubscriptionTimeoutSettings): ActorMaterializerSettings

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

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

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

  24. def withSyncProcessingLimit(limit: Int): ActorMaterializerSettings

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