akka.actor

Props

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

Props is a ActorRef configuration object, that is immutable, so it 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(..));
Annotations
@SerialVersionUID( 1L )
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Props
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

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

    Java API: create Props from a given Class

  2. new Props(factory: UntypedActorFactory)

    Java API: create Props from an UntypedActorFactory

  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 clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  8. val creator: () ⇒ Actor

  9. val deploy: Deploy

  10. val dispatcher: String

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

    Definition Classes
    AnyRef

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()

  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  16. final def notify(): Unit

    Definition Classes
    AnyRef

  17. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  18. val routerConfig: RouterConfig

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

    Definition Classes
    AnyRef

  20. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  21. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  22. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

  23. def withCreator(c: Class[_ <: Actor]): Props

    Java API: Returns a new Props with the specified creator set.

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

    Java API: Returns a new Props with the specified creator set.

    Java API: Returns a new Props with the specified creator set.

    The creator must not return the same instance multiple times.

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

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

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

    The creator must not return the same instance multiple times.

  26. def withDeploy(d: Deploy): Props

    Returns a new Props with the specified deployment configuration.

  27. def withDispatcher(d: String): Props

    Returns a new Props with the specified dispatcher set.

  28. def withRouter(r: RouterConfig): Props

    Returns a new Props with the specified router config set.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped