Package akka.actor.typed
Class Props
- java.lang.Object
-
- akka.actor.typed.Props
-
- All Implemented Interfaces:
java.io.Serializable
,scala.Equals
,scala.Product
- Direct Known Subclasses:
ActorTags
,DispatcherSelector
,MailboxSelector
,PropsImpl.EmptyProps$
public abstract class Props extends java.lang.Object implements scala.Product, java.io.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
All Methods Static Methods Instance Methods Concrete Methods 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 theActorSystem
default executor to this Props.Props
withDispatcherFromConfig(java.lang.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(java.lang.String path)
Prepend a selection of the mailbox found at the given Config path to this Props.
-
-
-
Method Detail
-
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 theActorSystem
default executor to this Props.
-
withDispatcherFromConfig
public Props withDispatcherFromConfig(java.lang.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 theActorSystem
that looks up the executor.
-
withDispatcherSameAsParent
public Props withDispatcherSameAsParent()
Prepend a selection of the same executor as the parent actor to this Props.
-
withMailboxFromConfig
public Props withMailboxFromConfig(java.lang.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 theActorSystem
that looks up the mailbox.
-
-