Package org.apache.pekko.actor.typed

Class Props

java.lang.Object

org.apache.pekko.actor.typed.Props

All Implemented Interfaces:

Serializable, scala.Equals, scala.Product

Direct Known Subclasses:

ActorTags, DispatcherSelector, MailboxSelector, PropsImpl.EmptyProps$

public abstract class Props
extends Object
implements scala.Product, Serializable

Data structure for describing an actor’s props details like which executor to run it on. For each type of setting (e.g. DispatcherSelector) 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.

Not for user extension.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static Props	empty()	Empty props instance, should seldom be needed in user code but can be useful as a default props where custom configuration of an actor is possible.
Props	withDispatcherDefault()	Prepend a selection of the ActorSystem default executor to this Props.
Props	withDispatcherFromConfig(String path)	Prepend a selection of the executor found at the given Config path to this Props.
Props	withDispatcherSameAsParent()	Prepend a selection of the same executor as the parent actor to this Props.
Props	withMailboxFromConfig(String path)	Prepend a selection of the mailbox found at the given Config path to this Props.

Methods inherited from class java.lang.Object

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

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productElementName, productElementNames, productIterator, productPrefix

Method Details

empty

public static Props empty()

Empty props instance, should seldom be needed in user code but can be useful as a default props where custom configuration of an actor is possible.

withDispatcherDefault

public Props withDispatcherDefault()

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

withDispatcherFromConfig

public Props withDispatcherFromConfig(String path)

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

withMailboxFromConfig

public Props withMailboxFromConfig(String path)

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

Since:

1.1.0

withDispatcherSameAsParent

public Props withDispatcherSameAsParent()

Prepend a selection of the same executor as the parent actor to this Props.