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

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. val autoFusing: Boolean
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. val debugLogging: Boolean
  10. val dispatcher: String
  11. 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
  12. 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
  13. 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
  14. 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
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(other: Any): Boolean
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. 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()
  19. val fuzzingMode: Boolean
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. val initialInputBufferSize: Int
  23. val ioSettings: IOSettings
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. val maxFixedBufferSize: Int
  26. val maxInputBufferSize: Int
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  30. val outputBurstLimit: Int
  31. val subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings
  32. val supervisionDecider: Decider
  33. val syncProcessingLimit: Int
  34. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  35. def toString(): String
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  39. def withDebugLogging(enable: Boolean): ActorMaterializerSettings

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

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

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

  42. def withIOSettings(ioSettings: IOSettings): ActorMaterializerSettings
  43. 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

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

  45. def withOutputBurstLimit(limit: Int): ActorMaterializerSettings

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

  46. def withSubscriptionTimeoutSettings(settings: StreamSubscriptionTimeoutSettings): ActorMaterializerSettings

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

  47. 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 stage basis and is not supported by every stage.

  48. 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 stage basis and is not supported by every stage.

  49. def withSyncProcessingLimit(limit: Int): ActorMaterializerSettings

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

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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.5.0) Turning off fusing is no longer possible with the traversal based materializer

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