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. val cachingConfig: CachingConfig
  2. val defaultDispatcherConfig: Config
  3. def defaultGlobalDispatcher: MessageDispatcher

    The one and only default dispatcher.

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

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

  6. val prerequisites: DispatcherPrerequisites
  7. 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.

  8. val settings: Settings