akka.actor

Props

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( 2L )
Source
Props.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Props
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Props(deploy: Deploy, clazz: Class[_], args: Seq[Any])

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Props to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Props, B)

    Implicit information
    This member is added by an implicit conversion from Props to ArrowAssoc[Props] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. 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.

  9. val args: Seq[Any]

  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. val clazz: Class[_]

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. val deploy: Deploy

  14. def dispatcher: String

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

  15. def ensuring(cond: (Props) ⇒ Boolean, msg: ⇒ Any): Props

    Implicit information
    This member is added by an implicit conversion from Props to Ensuring[Props] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (Props) ⇒ Boolean): Props

    Implicit information
    This member is added by an implicit conversion from Props to Ensuring[Props] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: ⇒ Any): Props

    Implicit information
    This member is added by an implicit conversion from Props to Ensuring[Props] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): Props

    Implicit information
    This member is added by an implicit conversion from Props to Ensuring[Props] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  21. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Props to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  22. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def mailbox: String

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

  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. def routerConfig: RouterConfig

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

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. def withDeploy(d: Deploy): Props

    Returns a new Props with the specified deployment configuration.

  34. def withDispatcher(d: String): Props

    Returns a new Props with the specified dispatcher set.

  35. def withMailbox(m: String): Props

    Returns a new Props with the specified mailbox set.

  36. def withRouter(r: RouterConfig): Props

    Returns a new Props with the specified router config set.

  37. def [B](y: B): (Props, B)

    Implicit information
    This member is added by an implicit conversion from Props to ArrowAssoc[Props] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Props to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (props: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Props to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (props: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Props

    Implicit information
    This member is added by an implicit conversion from Props to ArrowAssoc[Props] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (props: ArrowAssoc[Props]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Props

    Implicit information
    This member is added by an implicit conversion from Props to Ensuring[Props] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (props: Ensuring[Props]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Props to StringAdd

Inherited by implicit conversion any2stringfmt from Props to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Props to ArrowAssoc[Props]

Inherited by implicit conversion any2Ensuring from Props to Ensuring[Props]

Ungrouped