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 pekko.actor.default-dispatcher
section of the reference.conf
for documentation of dispatcher options.
Not for user instantiation or extension
- Annotations
- @DoNotInherit()
- Source
- Dispatchers.scala
- Alphabetic
- By Inheritance
- Dispatchers
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
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 Dispatchers toany2stringadd[Dispatchers] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val cachingConfig: CachingConfig
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- val defaultDispatcherConfig: Config
- def defaultGlobalDispatcher: MessageDispatcher
The one and only default dispatcher.
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- 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.
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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.
- 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 prerequisites: DispatcherPrerequisites
- 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 pekko.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. - val settings: Settings
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- 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])
Deprecated Value Members
- 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 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 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.
- 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.