Packages

final case class Props(deploy: Deploy, clazz: Class[_], args: Seq[Any]) extends Product with Serializable

Props is a configuration object using in creating an Actor; it is immutable, so it is thread-safe and fully shareable.

Examples on Scala API:

val props = Props.empty
val props = Props[MyActor]
val props = Props(classOf[MyActor], arg1, arg2)

val otherProps = props.withDispatcher("dispatcher-id")
val otherProps = props.withDeploy(<deployment info>)

Examples on Java API:

final Props props = Props.empty();
final Props props = Props.create(MyActor.class, arg1, arg2);

final Props otherProps = props.withDispatcher("dispatcher-id");
final Props otherProps = props.withDeploy(<deployment info>);
Annotations
@SerialVersionUID()
Source
Props.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Props
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. 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 Props(deploy: Deploy, clazz: Class[_], args: Seq[Any])

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 Props toany2stringadd[Props] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Props, B)
    Implicit
    This member is added by an implicit conversion from Props toArrowAssoc[Props] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def actorClass(): Class[_ <: Actor]

    Obtain an upper-bound approximation of the actor class which is going to be created by these Props.

    Obtain an upper-bound approximation of the actor class which is going to be created by these Props. In other words, the actor factory method will produce an instance of this class or a subclass thereof. This is used by the actor system to select special dispatchers or mailboxes in case dependencies are encoded in the actor type.

  7. val args: Seq[Any]
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. val clazz: Class[_]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  11. val deploy: Deploy
  12. def dispatcher: String

    Convenience method for extracting the dispatcher information from the contained Deploy instance.

  13. def ensuring(cond: (Props) => Boolean, msg: => Any): Props
    Implicit
    This member is added by an implicit conversion from Props toEnsuring[Props] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: (Props) => Boolean): Props
    Implicit
    This member is added by an implicit conversion from Props toEnsuring[Props] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean, msg: => Any): Props
    Implicit
    This member is added by an implicit conversion from Props toEnsuring[Props] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: Boolean): Props
    Implicit
    This member is added by an implicit conversion from Props toEnsuring[Props] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def mailbox: String

    Convenience method for extracting the mailbox information from the contained Deploy instance.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. def routerConfig: RouterConfig

    Convenience method for extracting the router configuration from the contained Deploy instance.

  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. def withActorTags(tags: Set[String]): Props

    Scala API: Returns a new Props with the specified set of tags.

  31. def withActorTags(tags: String*): Props

    Returns a new Props with the specified set of tags.

    Returns a new Props with the specified set of tags.

    Annotations
    @varargs()
  32. def withDeploy(d: Deploy): Props

    Returns a new Props with the specified deployment configuration.

  33. def withDispatcher(d: String): Props

    Returns a new Props with the specified dispatcher set.

  34. def withMailbox(m: String): Props

    Returns a new Props with the specified mailbox set.

  35. def withRouter(r: RouterConfig): Props

    Returns a new Props with the specified router config set.

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 Props toStringFormat[Props] 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): (Props, B)
    Implicit
    This member is added by an implicit conversion from Props toArrowAssoc[Props] 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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromProps to any2stringadd[Props]

Inherited by implicit conversion StringFormat fromProps to StringFormat[Props]

Inherited by implicit conversion Ensuring fromProps to Ensuring[Props]

Inherited by implicit conversion ArrowAssoc fromProps to ArrowAssoc[Props]

Ungrouped