Class SpawnProtocol$


  • public class SpawnProtocol$
    extends java.lang.Object
    A message protocol for actors that support spawning a child actor when receiving a SpawnProtocol#Spawn message and sending back the ActorRef of the child actor. Create instances through the SpawnProtocol.apply() or SpawnProtocol.create() factory methods.

    The typical usage of this is to use it as the guardian actor of the ActorSystem, possibly combined with Behaviors.setup to starts some initial tasks or actors. Child actors can then be started from the outside by telling or asking SpawnProtocol#Spawn to the actor reference of the system. When using ask this is similar to how ActorRefFactory.actorOf(akka.actor.Props) can be used in classic actors with the difference that a Future / CompletionStage of the ActorRef is returned.

    Stopping children is done through specific support in the protocol of the children, or stopping the entire spawn protocol actor.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static SpawnProtocol$ MODULE$
      Static reference to the singleton instance of this Scala object.
    • Constructor Summary

      Constructors 
      Constructor Description
      SpawnProtocol$()  
    • Field Detail

      • MODULE$

        public static final SpawnProtocol$ MODULE$
        Static reference to the singleton instance of this Scala object.
    • Constructor Detail

      • SpawnProtocol$

        public SpawnProtocol$()
    • Method Detail

      • create

        public Behavior<SpawnProtocol.Command> create()
        Java API: returns a behavior that can be commanded to spawn arbitrary children.
        Returns:
        (undocumented)
      • apply

        public Behavior<SpawnProtocol.Command> apply()
        Scala API: returns a behavior that can be commanded to spawn arbitrary children.
        Returns:
        (undocumented)