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.

Annotations
@nowarn()
Source
ActorMaterializer.scala
Linear Supertypes
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. Protected

Value Members

  1. def equals(other: Any): Boolean
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  2. val ioSettings: IOSettings
  3. val streamRefSettings: StreamRefSettings
  4. val subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings
  5. def toString(): String
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  6. def withIOSettings(ioSettings: IOSettings): ActorMaterializerSettings
  7. def withStreamRefSettings(streamRefSettings: StreamRefSettings): ActorMaterializerSettings

    Change settings specific to and SinkRef.

  8. def withSubscriptionTimeoutSettings(settings: StreamSubscriptionTimeoutSettings): ActorMaterializerSettings

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

Deprecated Value Members

  1. val autoFusing: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) No longer has any effect

  2. val blockingIoDispatcher: String
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.BlockingIoDispatcher' to read the concrete setting value

  3. val debugLogging: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.DebugLogging' to read the concrete setting value

  4. val dispatcher: String
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.Dispatcher' to read the concrete setting value

  5. val fuzzingMode: Boolean
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.FuzzingMode' to read the concrete setting value

  6. val initialInputBufferSize: Int
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'Attributes.InputBuffer' to read the concrete setting value

  7. val maxFixedBufferSize: Int
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.MaxFixedBufferSize' to read the concrete setting value

  8. val maxInputBufferSize: Int
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'Attributes.InputBuffer' to read the concrete setting value

  9. val outputBurstLimit: Int
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.OutputBurstLimit' to read the concrete setting value

  10. val supervisionDecider: Decider
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.SupervisionStrategy' to read the concrete setting value

  11. val syncProcessingLimit: Int
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.SyncProcessingLimit' to read the concrete setting value

  12. def withBlockingIoDispatcher(newBlockingIoDispatcher: String): ActorMaterializerSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.BlockingIoDispatcher' to change setting value

  13. def withDebugLogging(enable: Boolean): ActorMaterializerSettings

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.DebugLogging' to change setting value

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.Dispatcher' to change setting value

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.FuzzingMode' to change setting value

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'Attributes.InputBuffer' to change setting value

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.MaxFixedBufferSize' to change setting value

  18. def withOutputBurstLimit(limit: Int): ActorMaterializerSettings

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.OutputBurstLimit' to change setting value

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.SupervisionStrategy' to change setting value

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.supervisionStrategy' to change setting value

  21. def withSyncProcessingLimit(limit: Int): ActorMaterializerSettings

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.0) Use attribute 'ActorAttributes.SyncProcessingLimit' to change setting value