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.

Annotations
@silent( "deprecated" )
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. 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. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ActorMaterializerSettings to any2stringadd[ActorMaterializerSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ActorMaterializerSettings, B)
    Implicit
    This member is added by an implicit conversion from ActorMaterializerSettings to ArrowAssoc[ActorMaterializerSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (ActorMaterializerSettings) ⇒ Boolean, msg: ⇒ Any): ActorMaterializerSettings
    Implicit
    This member is added by an implicit conversion from ActorMaterializerSettings to Ensuring[ActorMaterializerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ActorMaterializerSettings) ⇒ Boolean): ActorMaterializerSettings
    Implicit
    This member is added by an implicit conversion from ActorMaterializerSettings to Ensuring[ActorMaterializerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): ActorMaterializerSettings
    Implicit
    This member is added by an implicit conversion from ActorMaterializerSettings to Ensuring[ActorMaterializerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ActorMaterializerSettings
    Implicit
    This member is added by an implicit conversion from ActorMaterializerSettings to Ensuring[ActorMaterializerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(other: Any): Boolean
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ActorMaterializerSettings to StringFormat[ActorMaterializerSettings] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. val ioSettings: IOSettings
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val streamRefSettings: StreamRefSettings
  23. val subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def withIOSettings(ioSettings: IOSettings): ActorMaterializerSettings
  30. def withStreamRefSettings(streamRefSettings: StreamRefSettings): ActorMaterializerSettings

    Change settings specific to SourceRef and SinkRef.

  31. def withSubscriptionTimeoutSettings(settings: StreamSubscriptionTimeoutSettings): ActorMaterializerSettings

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

  32. def [B](y: B): (ActorMaterializerSettings, B)
    Implicit
    This member is added by an implicit conversion from ActorMaterializerSettings to ArrowAssoc[ActorMaterializerSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

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

  6. val fuzzingMode: Boolean
    Annotations
    @deprecated
    Deprecated

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

  7. val initialInputBufferSize: Int
    Annotations
    @deprecated
    Deprecated

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

  8. val maxFixedBufferSize: Int
    Annotations
    @deprecated
    Deprecated

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

  9. val maxInputBufferSize: Int
    Annotations
    @deprecated
    Deprecated

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

  10. val outputBurstLimit: Int
    Annotations
    @deprecated
    Deprecated

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

  11. val supervisionDecider: Decider
    Annotations
    @deprecated
    Deprecated

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

  12. val syncProcessingLimit: Int
    Annotations
    @deprecated
    Deprecated

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

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

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

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ActorMaterializerSettings to any2stringadd[ActorMaterializerSettings]

Inherited by implicit conversion StringFormat from ActorMaterializerSettings to StringFormat[ActorMaterializerSettings]

Inherited by implicit conversion Ensuring from ActorMaterializerSettings to Ensuring[ActorMaterializerSettings]

Inherited by implicit conversion ArrowAssoc from ActorMaterializerSettings to ArrowAssoc[ActorMaterializerSettings]

Ungrouped