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. 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.

  2. val args: Seq[Any]
  3. val clazz: Class[_]
  4. val deploy: Deploy
  5. def dispatcher: String

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

  6. def mailbox: String

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

  7. def productElementNames: Iterator[String]
    Definition Classes
    Product
  8. def routerConfig: RouterConfig

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

  9. def withActorTags(tags: Set[String]): Props

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

  10. 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()
  11. def withDeploy(d: Deploy): Props

    Returns a new Props with the specified deployment configuration.

  12. def withDispatcher(d: String): Props

    Returns a new Props with the specified dispatcher set.

  13. def withMailbox(m: String): Props

    Returns a new Props with the specified mailbox set.

  14. def withRouter(r: RouterConfig): Props

    Returns a new Props with the specified router config set.