Package org.apache.pekko.actor.typed
Class SpawnProtocol
- java.lang.Object
-
- org.apache.pekko.actor.typed.SpawnProtocol
-
public class SpawnProtocol extends java.lang.Object
A message protocol for actors that support spawning a child actor when receiving aSpawnProtocol#Spawn
message and sending back theActorRef
of the child actor. Create instances through theapply()
orcreate()
factory methods.The typical usage of this is to use it as the guardian actor of the
ActorSystem
, possibly combined withBehaviors.setup
to starts some initial tasks or actors. Child actors can then be started from the outside by telling or askingSpawnProtocol#Spawn
to the actor reference of the system. When usingask
this is similar to howpekko.actor.ActorSystem#actorOf
can be used in classic actors with the difference that aFuture
/CompletionStage
of theActorRef
is returned.Stopping children is done through specific support in the protocol of the children, or stopping the entire spawn protocol actor.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
SpawnProtocol.Command
Not for user extensionstatic class
SpawnProtocol.Spawn<T>
Spawn a child actor with the givenbehavior
and send back theActorRef
of that child to the givenreplyTo
destination.static class
SpawnProtocol.Spawn$
-
Constructor Summary
Constructors Constructor Description SpawnProtocol()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static Behavior<SpawnProtocol.Command>
apply()
Scala API: returns a behavior that can be commanded to spawn arbitrary children.static Behavior<SpawnProtocol.Command>
create()
Java API: returns a behavior that can be commanded to spawn arbitrary children.
-
-
-
Method Detail
-
create
public static Behavior<SpawnProtocol.Command> create()
Java API: returns a behavior that can be commanded to spawn arbitrary children.
-
apply
public static Behavior<SpawnProtocol.Command> apply()
Scala API: returns a behavior that can be commanded to spawn arbitrary children.
-
-