akka.typed

Class DeploymentConfig

java.lang.Object

akka.typed.DeploymentConfig

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product

Direct Known Subclasses:

DispatcherDefault, DispatcherFromConfig, DispatcherFromExecutionContext, DispatcherFromExecutor, EmptyDeploymentConfig$, MailboxCapacity

public abstract class DeploymentConfig
extends java.lang.Object
implements scala.Product, scala.Serializable

Data structure for describing an actor’s deployment details like which executor to run it on. For each type of setting (e.g. DispatcherSelector or MailboxCapacity) the FIRST occurrence is used when creating the actor; this means that adding configuration using the "with" methods overrides what was configured previously.

Deliberately not sealed in order to emphasize future extensibility by the framework—this is not intended to be extended by user code.

The DeploymentConfig includes a next reference so that it can form an internally linked list. Traversal of this list stops when encountering the EmptyDeploymentConfig$ object.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeploymentConfig()

Method Summary

Modifier and Type	Method and Description
<T extends DeploymentConfig> scala.collection.immutable.List<DeploymentConfig>	allOf(scala.reflect.ClassTag<T> evidence$2) Retrieve all configuration nodes of a given type in the order that they are present in this DeploymentConfig.
<T extends DeploymentConfig> DeploymentConfig	filterNot(scala.reflect.ClassTag<T> evidence$3) Remove all configuration nodes of a given type and return the resulting DeploymentConfig.
<T extends DeploymentConfig> T	firstOrElse(T default_, scala.reflect.ClassTag<T> evidence$1) Find the first occurrence of a configuration node of the given type, falling back to the provided default if none is found.
abstract DeploymentConfig	next() Reference to the tail of this DeploymentConfig list.
DeploymentConfig	withDispatcherDefault() Prepend a selection of the ActorSystem default executor to this DeploymentConfig.
DeploymentConfig	withDispatcherFromConfig(java.lang.String path) Prepend a selection of the executor found at the given Config path to this DeploymentConfig.
DeploymentConfig	withDispatcherFromExecutionContext(scala.concurrent.ExecutionContext ec) Prepend a selection of the given execution context to this DeploymentConfig.
DeploymentConfig	withDispatcherFromExecutor(java.util.concurrent.Executor executor) Prepend a selection of the given executor to this DeploymentConfig.
DeploymentConfig	withMailboxCapacity(int capacity) Prepend the given mailbox capacity configuration to this DeploymentConfig.
abstract DeploymentConfig	withNext(DeploymentConfig next) Create a copy of this DeploymentConfig node with its next reference replaced by the given object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Product

$init$, productArity, productElement, productIterator, productPrefix

Methods inherited from interface scala.Equals

canEqual, equals

Constructor Detail

DeploymentConfig

public DeploymentConfig()

Method Detail

next

public abstract DeploymentConfig next()

Reference to the tail of this DeploymentConfig list.

Returns:

(undocumented)

withNext

public abstract DeploymentConfig withNext(DeploymentConfig next)

Create a copy of this DeploymentConfig node with its next reference replaced by the given object. This does NOT append the given list of configuration nodes to the current list!

Parameters:

next - (undocumented)

Returns:

(undocumented)

withDispatcherDefault

public DeploymentConfig withDispatcherDefault()

Prepend a selection of the ActorSystem default executor to this DeploymentConfig.

Returns:

(undocumented)

withDispatcherFromConfig

public DeploymentConfig withDispatcherFromConfig(java.lang.String path)

Prepend a selection of the executor found at the given Config path to this DeploymentConfig. The path is relative to the configuration root of the ActorSystem that looks up the executor.

Parameters:

path - (undocumented)

Returns:

(undocumented)

withDispatcherFromExecutor

public DeploymentConfig withDispatcherFromExecutor(java.util.concurrent.Executor executor)

Prepend a selection of the given executor to this DeploymentConfig.

Parameters:

executor - (undocumented)

Returns:

(undocumented)

withDispatcherFromExecutionContext

public DeploymentConfig withDispatcherFromExecutionContext(scala.concurrent.ExecutionContext ec)

Prepend a selection of the given execution context to this DeploymentConfig.

Parameters:

ec - (undocumented)

Returns:

(undocumented)

withMailboxCapacity

public DeploymentConfig withMailboxCapacity(int capacity)

Prepend the given mailbox capacity configuration to this DeploymentConfig.

Parameters:

capacity - (undocumented)

Returns:

(undocumented)

firstOrElse

public <T extends DeploymentConfig> T firstOrElse(T default_,
                                                  scala.reflect.ClassTag<T> evidence$1)

Find the first occurrence of a configuration node of the given type, falling back to the provided default if none is found.

Parameters:

default_ - (undocumented)

evidence$1 - (undocumented)

Returns:

(undocumented)

allOf

public <T extends DeploymentConfig> scala.collection.immutable.List<DeploymentConfig> allOf(scala.reflect.ClassTag<T> evidence$2)

Retrieve all configuration nodes of a given type in the order that they are present in this DeploymentConfig. The next reference for all returned nodes will be the EmptyDeploymentConfig$.

Parameters:

evidence$2 - (undocumented)

Returns:

(undocumented)

filterNot

public <T extends DeploymentConfig> DeploymentConfig filterNot(scala.reflect.ClassTag<T> evidence$3)

Remove all configuration nodes of a given type and return the resulting DeploymentConfig.

Parameters:

evidence$3 - (undocumented)

Returns:

(undocumented)