Packages

  • package root
    Definition Classes
    root
  • package akka
    Definition Classes
    root
  • package actor
    Definition Classes
    akka
  • package typed
    Definition Classes
    actor
  • object SpawnProtocol

    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.

    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 akka.actor.ActorSystem#actorOf 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.

    Definition Classes
    typed
  • Command
  • Spawn

final case class Spawn[T](behavior: Behavior[T], name: String, props: Props, replyTo: ActorRef[ActorRef[T]]) extends Command with Product with Serializable

Spawn a child actor with the given behavior and send back the ActorRef of that child to the given replyTo destination.

If name is an empty string an anonymous actor (with automatically generated name) will be created.

If the name is already taken of an existing actor a unique name will be used by appending a suffix to the the name. The exact format or value of the suffix is an implementation detail that is undefined. This means that reusing the same name for several actors will not result in InvalidActorNameException, but it's better to use unique names to begin with.

Source
SpawnProtocol.scala
Linear Supertypes
Serializable, Product, Equals, Command, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Spawn
  2. Serializable
  3. Product
  4. Equals
  5. Command
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Spawn(behavior: Behavior[T], name: String, props: Props, replyTo: ActorRef[ActorRef[T]])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from Spawn[T] toany2stringadd[Spawn[T]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Spawn[T], B)
    Implicit
    This member is added by an implicit conversion from Spawn[T] toArrowAssoc[Spawn[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val behavior: Behavior[T]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def ensuring(cond: (Spawn[T]) => Boolean, msg: => Any): Spawn[T]
    Implicit
    This member is added by an implicit conversion from Spawn[T] toEnsuring[Spawn[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (Spawn[T]) => Boolean): Spawn[T]
    Implicit
    This member is added by an implicit conversion from Spawn[T] toEnsuring[Spawn[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): Spawn[T]
    Implicit
    This member is added by an implicit conversion from Spawn[T] toEnsuring[Spawn[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): Spawn[T]
    Implicit
    This member is added by an implicit conversion from Spawn[T] toEnsuring[Spawn[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val name: String
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val props: Props
  22. val replyTo: ActorRef[ActorRef[T]]
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Spawn[T] toStringFormat[Spawn[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Spawn[T], B)
    Implicit
    This member is added by an implicit conversion from Spawn[T] toArrowAssoc[Spawn[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Command

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromSpawn[T] to any2stringadd[Spawn[T]]

Inherited by implicit conversion StringFormat fromSpawn[T] to StringFormat[Spawn[T]]

Inherited by implicit conversion Ensuring fromSpawn[T] to Ensuring[Spawn[T]]

Inherited by implicit conversion ArrowAssoc fromSpawn[T] to ArrowAssoc[Spawn[T]]

Ungrouped