Packages

class Dispatchers extends AnyRef

Dispatchers are to be defined in configuration to allow for tuning for different environments. Use the lookup method to create a dispatcher as specified in configuration.

A dispatcher config can also be an alias, in that case it is a config string value pointing to the actual dispatcher config.

Look in akka.actor.default-dispatcher section of the reference.conf for documentation of dispatcher options.

Not for user instantiation or extension

Annotations
@DoNotInherit()
Source
Dispatchers.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Dispatchers
  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. Protected

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 Dispatchers toany2stringadd[Dispatchers] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Dispatchers, B)
    Implicit
    This member is added by an implicit conversion from Dispatchers toArrowAssoc[Dispatchers] 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 cachingConfig: CachingConfig
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. val defaultDispatcherConfig: Config
  10. def defaultGlobalDispatcher: MessageDispatcher

    The one and only default dispatcher.

  11. def ensuring(cond: (Dispatchers) => Boolean, msg: => Any): Dispatchers
    Implicit
    This member is added by an implicit conversion from Dispatchers toEnsuring[Dispatchers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Dispatchers) => Boolean): Dispatchers
    Implicit
    This member is added by an implicit conversion from Dispatchers toEnsuring[Dispatchers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Dispatchers
    Implicit
    This member is added by an implicit conversion from Dispatchers toEnsuring[Dispatchers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Dispatchers
    Implicit
    This member is added by an implicit conversion from Dispatchers toEnsuring[Dispatchers] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def hasDispatcher(id: String): Boolean

    Checks that the configuration provides a section for the given dispatcher.

    Checks that the configuration provides a section for the given dispatcher. This does not guarantee that no ConfigurationException will be thrown when using this dispatcher, because the details can only be checked by trying to instantiate it, which might be undesirable when just checking.

  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def lookup(id: String): MessageDispatcher

    Returns a dispatcher as specified in configuration.

    Returns a dispatcher as specified in configuration. Please note that this method _may_ create and return a NEW dispatcher, _every_ call (depending on the MessageDispatcherConfigurator / dispatcher config the id points to).

    A dispatcher id can also be an alias. In the case it is a string value in the config it is treated as the id of the actual dispatcher config to use. If several ids leading to the same actual dispatcher config is used only one instance is created. This means that for dispatchers you expect to be shared they will be.

    Throws ConfigurationException if the specified dispatcher cannot be found in the configuration.

  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. val prerequisites: DispatcherPrerequisites
  26. def registerConfigurator(id: String, configurator: MessageDispatcherConfigurator): Boolean

    Register a MessageDispatcherConfigurator that will be used by #lookup and #hasDispatcher instead of looking up the configurator from the system configuration.

    Register a MessageDispatcherConfigurator that will be used by #lookup and #hasDispatcher instead of looking up the configurator from the system configuration. This enables dynamic addition of dispatchers, as used by the akka.routing.BalancingPool.

    A configurator for a certain id can only be registered once, i.e. it can not be replaced. It is safe to call this method multiple times, but only the first registration will be used. This method returns true if the specified configurator was successfully registered.

  27. val settings: Settings
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated
  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Dispatchers toStringFormat[Dispatchers] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Dispatchers, B)
    Implicit
    This member is added by an implicit conversion from Dispatchers toArrowAssoc[Dispatchers] 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.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDispatchers to any2stringadd[Dispatchers]

Inherited by implicit conversion StringFormat fromDispatchers to StringFormat[Dispatchers]

Inherited by implicit conversion Ensuring fromDispatchers to Ensuring[Dispatchers]

Inherited by implicit conversion ArrowAssoc fromDispatchers to ArrowAssoc[Dispatchers]

Ungrouped