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
- Alphabetic
- By Inheritance
- ActorMaterializerSettings
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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 Akka 2.5.10) Use ActorMaterializerSettings.apply or ActorMaterializerSettings.create instead
- 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 Akka 2.5.10) Use ActorMaterializerSettings.apply or ActorMaterializerSettings.create instead
- 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 Akka 2.5.10) Use ActorMaterializerSettings.apply or ActorMaterializerSettings.create instead
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from ActorMaterializerSettings toany2stringadd[ActorMaterializerSettings] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ActorMaterializerSettings, B)
- Implicit
- This member is added by an implicit conversion from ActorMaterializerSettings toArrowAssoc[ActorMaterializerSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def ensuring(cond: (ActorMaterializerSettings) => Boolean, msg: => Any): ActorMaterializerSettings
- Implicit
- This member is added by an implicit conversion from ActorMaterializerSettings toEnsuring[ActorMaterializerSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ActorMaterializerSettings) => Boolean): ActorMaterializerSettings
- Implicit
- This member is added by an implicit conversion from ActorMaterializerSettings toEnsuring[ActorMaterializerSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ActorMaterializerSettings
- Implicit
- This member is added by an implicit conversion from ActorMaterializerSettings toEnsuring[ActorMaterializerSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ActorMaterializerSettings
- Implicit
- This member is added by an implicit conversion from ActorMaterializerSettings toEnsuring[ActorMaterializerSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(other: Any): Boolean
- Definition Classes
- ActorMaterializerSettings → AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val ioSettings: IOSettings
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val streamRefSettings: StreamRefSettings
- val subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- ActorMaterializerSettings → AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withIOSettings(ioSettings: IOSettings): ActorMaterializerSettings
- def withStreamRefSettings(streamRefSettings: StreamRefSettings): ActorMaterializerSettings
- 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
- val autoFusing: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) No longer has any effect
- val blockingIoDispatcher: String
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.BlockingIoDispatcher' to read the concrete setting value
- val debugLogging: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.DebugLogging' to read the concrete setting value
- val dispatcher: String
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.Dispatcher' to read the concrete setting value
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from ActorMaterializerSettings toStringFormat[ActorMaterializerSettings] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)
instead ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- val fuzzingMode: Boolean
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.FuzzingMode' to read the concrete setting value
- val initialInputBufferSize: Int
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'Attributes.InputBuffer' to read the concrete setting value
- val maxFixedBufferSize: Int
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.MaxFixedBufferSize' to read the concrete setting value
- val maxInputBufferSize: Int
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'Attributes.InputBuffer' to read the concrete setting value
- val outputBurstLimit: Int
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.OutputBurstLimit' to read the concrete setting value
- val supervisionDecider: Decider
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.SupervisionStrategy' to read the concrete setting value
- val syncProcessingLimit: Int
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.SyncProcessingLimit' to read the concrete setting value
- def withBlockingIoDispatcher(newBlockingIoDispatcher: String): ActorMaterializerSettings
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.BlockingIoDispatcher' to change setting value
- 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 Akka 2.6.0) Use attribute 'ActorAttributes.DebugLogging' to change setting value
- 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 pekko.stream.Attributes#dispatcher.
- Annotations
- @deprecated
- Deprecated
(Since version Akka 2.6.0) Use attribute 'ActorAttributes.Dispatcher' to change setting value
- 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 Akka 2.6.0) Use attribute 'ActorAttributes.FuzzingMode' to change setting value
- 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 pekko.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 Akka 2.6.0) Use attribute 'Attributes.InputBuffer' to change setting value
- 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 Akka 2.6.0) Use attribute 'ActorAttributes.MaxFixedBufferSize' to change setting value
- 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 Akka 2.6.0) Use attribute 'ActorAttributes.OutputBurstLimit' to change setting value
- 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 pekko.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 pekko.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 Akka 2.6.0) Use attribute 'ActorAttributes.SupervisionStrategy' to change setting value
- 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 pekko.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 pekko.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 Akka 2.6.0) Use attribute 'ActorAttributes.supervisionStrategy' to change setting value
- 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 Akka 2.6.0) Use attribute 'ActorAttributes.SyncProcessingLimit' to change setting value
- def →[B](y: B): (ActorMaterializerSettings, B)
- Implicit
- This member is added by an implicit conversion from ActorMaterializerSettings toArrowAssoc[ActorMaterializerSettings] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->
instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.