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
- Alphabetic
- By Inheritance
- ActorMaterializerSettings
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ActorMaterializerSettings(initialInputBufferSize: Int, maxInputBufferSize: Int, dispatcher: String, supervisionDecider: Decider, subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings, debugLogging: Boolean, outputBurstLimit: Int, fuzzingMode: Boolean, autoFusing: Boolean, maxFixedBufferSize: Int)
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 to any2stringadd[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 to ArrowAssoc[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
- val autoFusing: Boolean
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
- val debugLogging: Boolean
- val dispatcher: String
-
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
-
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
-
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
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(other: Any): Boolean
- Definition Classes
- ActorMaterializerSettings → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
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()
- val fuzzingMode: Boolean
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- val initialInputBufferSize: Int
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val maxFixedBufferSize: Int
- val maxInputBufferSize: Int
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- val outputBurstLimit: Int
- val subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings
- val supervisionDecider: Decider
- val syncProcessingLimit: Int
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- ActorMaterializerSettings → AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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.
-
def
withDebugLogging(enable: Boolean): ActorMaterializerSettings
Enable to log all elements that are dropped due to failures (at DEBUG level).
-
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.
-
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.
-
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.
-
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.
-
def
withOutputBurstLimit(limit: Int): ActorMaterializerSettings
Maximum number of elements emitted in batch if downstream signals large demand.
-
def
withSubscriptionTimeoutSettings(settings: StreamSubscriptionTimeoutSettings): ActorMaterializerSettings
Leaked publishers and subscribers are cleaned up when they are not used within a given deadline, configured by StreamSubscriptionTimeoutSettings.
-
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.
-
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.
-
def
withSyncProcessingLimit(limit: Int): ActorMaterializerSettings
Limit for number of messages that can be processed synchronously in stream to substream communication
-
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