abstract class Props extends Product with 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.

Annotations
@DoNotInherit()
Source
Props.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Known Subclasses
ActorTags, DispatcherSelector, MailboxSelector
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

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def productArity: Int
    Definition Classes
    Product
  3. abstract def productElement(n: Int): Any
    Definition Classes
    Product

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. 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
  9. 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
  10. 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
  11. 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
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  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 productElementName(n: Int): String
    Definition Classes
    Product
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. def productIterator: Iterator[Any]
    Definition Classes
    Product
  23. def productPrefix: String
    Definition Classes
    Product
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. def toString(): String
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. def withDispatcherDefault: Props

    Prepend a selection of the ActorSystem default executor to this Props.

  30. def withDispatcherFromConfig(path: String): Props

    Prepend a selection of the executor found at the given Config path to this Props.

    Prepend a selection of the executor found at the given Config path to this Props. The path is relative to the configuration root of the ActorSystem that looks up the executor.

  31. def withDispatcherSameAsParent: Props

    Prepend a selection of the same executor as the parent actor to this Props.

  32. def withMailboxFromConfig(path: String): Props

    Prepend a selection of the mailbox found at the given Config path to this Props.

    Prepend a selection of the mailbox found at the given Config path to this Props. The path is relative to the configuration root of the ActorSystem that looks up the mailbox.

    Since

    1.1.0

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