Class/Object

akka.stream

ActorMaterializerSettings

Related Docs: object ActorMaterializerSettings | package stream

Permalink

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

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    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)

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. val autoFusing: Boolean

    Permalink
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  9. val debugLogging: Boolean

    Permalink
  10. val dispatcher: String

    Permalink
  11. def ensuring(cond: (ActorMaterializerSettings) ⇒ Boolean, msg: ⇒ Any): ActorMaterializerSettings

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Implicit information
    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

    Permalink
    Definition Classes
    AnyRef
  16. def equals(other: Any): Boolean

    Permalink
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    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()
  18. val fuzzingMode: Boolean

    Permalink
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  21. val initialInputBufferSize: Int

    Permalink
  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. val maxFixedBufferSize: Int

    Permalink
  24. val maxInputBufferSize: Int

    Permalink
  25. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  28. val outputBurstLimit: Int

    Permalink
  29. val subscriptionTimeoutSettings: StreamSubscriptionTimeoutSettings

    Permalink
  30. val supervisionDecider: Decider

    Permalink
  31. val syncProcessingLimit: Int

    Permalink
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

    Permalink
    Definition Classes
    ActorMaterializerSettings → AnyRef → Any
  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  37. def withDebugLogging(enable: Boolean): ActorMaterializerSettings

    Permalink

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

  38. def withDispatcher(dispatcher: String): ActorMaterializerSettings

    Permalink

    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.

  39. def withFuzzing(enable: Boolean): ActorMaterializerSettings

    Permalink

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

  40. def withInputBuffer(initialSize: Int, maxSize: Int): ActorMaterializerSettings

    Permalink

    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.

  41. def withMaxFixedBufferSize(size: Int): ActorMaterializerSettings

    Permalink

    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.

  42. def withOutputBurstLimit(limit: Int): ActorMaterializerSettings

    Permalink

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

  43. def withSubscriptionTimeoutSettings(settings: StreamSubscriptionTimeoutSettings): ActorMaterializerSettings

    Permalink

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

  44. def withSupervisionStrategy(decider: Function[Throwable, Directive]): ActorMaterializerSettings

    Permalink

    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.

  45. def withSupervisionStrategy(decider: Decider): ActorMaterializerSettings

    Permalink

    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.

  46. def withSyncProcessingLimit(limit: Int): ActorMaterializerSettings

    Permalink

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

  47. def [B](y: B): (ActorMaterializerSettings, B)

    Permalink
    Implicit information
    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 finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def withAutoFusing(enable: Boolean): ActorMaterializerSettings

    Permalink

    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