public class Dispatchers
extends java.lang.Object
lookup
method to create
a dispatcher as specified in configuration.
Look in akka.actor.default-dispatcher
section of the reference.conf
for documentation of dispatcher options.
Constructor and Description |
---|
Dispatchers(ActorSystem.Settings settings,
DispatcherPrerequisites prerequisites) |
Modifier and Type | Method and Description |
---|---|
akka.dispatch.CachingConfig |
cachingConfig() |
com.typesafe.config.Config |
defaultDispatcherConfig() |
static java.lang.String |
DefaultDispatcherId()
The id of the default dispatcher, also the full key of the
configuration of the default dispatcher.
|
MessageDispatcher |
defaultGlobalDispatcher()
The one and only default dispatcher.
|
boolean |
hasDispatcher(java.lang.String id)
Checks that the configuration provides a section for the given dispatcher.
|
MessageDispatcher |
lookup(java.lang.String id)
Returns a dispatcher as specified in configuration.
|
DispatcherPrerequisites |
prerequisites() |
boolean |
registerConfigurator(java.lang.String id,
MessageDispatcherConfigurator configurator)
Register a
MessageDispatcherConfigurator that will be
used by lookup(java.lang.String) and hasDispatcher(java.lang.String) instead of looking
up the configurator from the system configuration. |
ActorSystem.Settings |
settings() |
public Dispatchers(ActorSystem.Settings settings, DispatcherPrerequisites prerequisites)
public static final java.lang.String DefaultDispatcherId()
public ActorSystem.Settings settings()
public DispatcherPrerequisites prerequisites()
public akka.dispatch.CachingConfig cachingConfig()
public com.typesafe.config.Config defaultDispatcherConfig()
public MessageDispatcher defaultGlobalDispatcher()
public MessageDispatcher lookup(java.lang.String id)
ConfigurationException
- if the specified dispatcher cannot be found in the configurationpublic boolean hasDispatcher(java.lang.String id)
public boolean registerConfigurator(java.lang.String id, MessageDispatcherConfigurator configurator)
MessageDispatcherConfigurator
that will be
used by lookup(java.lang.String)
and hasDispatcher(java.lang.String)
instead of looking
up the configurator from the system configuration.
This enables dynamic addition of dispatchers, as used by the
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.