akka.actor

Props

case class Props(creator: () ⇒ Actor, dispatcher: String, routerConfig: RouterConfig, deploy: Deploy) extends Product with Serializable

Props is a ActorRef configuration object, that is thread safe and fully sharable. Used when creating new actors through; ActorSystem.actorOf and ActorContext.actorOf.

In case of providing code which creates the actual Actor instance, that must not return the same instance multiple times.

Examples on Scala API:

 val props = Props[MyActor]
 val props = Props(new MyActor)
 val props = Props(
   creator = ..,
   dispatcher = ..,
   routerConfig = ..
 )
 val props = Props().withCreator(new MyActor)
 val props = Props[MyActor].withRouter(RoundRobinRouter(..))

Examples on Java API:

 Props props = new Props();
 Props props = new Props(MyActor.class);
 Props props = new Props(new UntypedActorFactory() {
   public UntypedActor create() {
     return new MyActor();
   }
 });
 Props props = new Props().withCreator(new UntypedActorFactory() { ... });
 Props props = new Props(MyActor.class).withRouter(new RoundRobinRouter(..));
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. Props
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Props(actorClass: Class[_ <: akka.actor.Actor])

    Java API.

  2. new Props(factory: UntypedActorFactory)

    Java API.

  3. new Props()

    No-args constructor that sets all the default values.

  4. new Props(creator: () ⇒ Actor = Props.defaultCreator, dispatcher: String = ..., routerConfig: RouterConfig = Props.defaultRoutedProps, deploy: Deploy = Props.defaultDeploy)

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. final def ==(arg0: AnyRef): Boolean

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

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def canEqual(arg0: Any): Boolean

    Definition Classes
    Props → Equals
  8. def clone(): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  9. val creator: () ⇒ Actor

  10. val deploy: Deploy

  11. val dispatcher: String

  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Definition Classes
    Props → Equals → AnyRef → Any
  14. def finalize(): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  15. final def getClass(): java.lang.Class[_]

    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

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

    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  21. def productArity: Int

    Definition Classes
    Props → Product
  22. def productElement(arg0: Int): Any

    Definition Classes
    Props → Product
  23. def productIterator: Iterator[Any]

    Definition Classes
    Product
  24. def productPrefix: String

    Definition Classes
    Props → Product
  25. val routerConfig: RouterConfig

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

    Definition Classes
    AnyRef
  27. def toString(): String

    Definition Classes
    Props → AnyRef → Any
  28. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws()
  31. def withCreator(c: Class[_ <: akka.actor.Actor]): Props

    Returns a new Props with the specified creator set.

    Returns a new Props with the specified creator set.

    Java API.

  32. def withCreator(c: Creator[Actor]): Props

    Returns a new Props with the specified creator set.

    Returns a new Props with the specified creator set.

    The creator must not return the same instance multiple times.

    Java API.

  33. def withCreator(c: ⇒ Actor): Props

    Returns a new Props with the specified creator set.

    Returns a new Props with the specified creator set.

    The creator must not return the same instance multiple times.

    Scala API.

  34. def withDeploy(d: Deploy): Props

    Returns a new Props with the specified deployment configuration.

  35. def withDispatcher(d: String): Props

    Returns a new Props with the specified dispatcher set.

  36. def withRouter(r: RouterConfig): Props

    Returns a new Props with the specified router config set.

Deprecated Value Members

  1. def productElements: Iterator[Any]

    Definition Classes
    Product
    Annotations
    @deprecated
    Deprecated

    (Since version 2.8.0) use productIterator instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any