akka.actor.Props

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

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

Alphabetic
By inheritance

Inherited

Hide All
Show all

Props
Serializable
Serializable
Product
Equals
AnyRef
Any

Visibility

Public
All

Instance Constructors

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

Java API.
new Props (factory: UntypedActorFactory)

Java API.
new Props ()

No-args constructor that sets all the default values.
new Props (creator: () ⇒ Actor, dispatcher: String, routerConfig: RouterConfig, deploy: Deploy)

Value Members

def != (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
Any
def ## (): Int

Attributes
final
Definition Classes
AnyRef → Any
def == (arg0: AnyRef): Boolean

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

Attributes
final
Definition Classes
Any
def asInstanceOf [T0] : T0

Attributes
final
Definition Classes
Any
def canEqual (arg0: Any): Boolean

Definition Classes
Props → Equals
def clone (): AnyRef

Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws()
val creator : () ⇒ Actor
val deploy : Deploy
val dispatcher : String
def eq (arg0: AnyRef): Boolean

Attributes
final
Definition Classes
AnyRef
def equals (arg0: Any): Boolean

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

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

Attributes
final
Definition Classes
AnyRef → Any
def hashCode (): Int

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

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

Attributes
final
Definition Classes
AnyRef
def notify (): Unit

Attributes
final
Definition Classes
AnyRef
def notifyAll (): Unit

Attributes
final
Definition Classes
AnyRef
def productArity : Int

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

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

Definition Classes
Product
def productPrefix : String

Definition Classes
Props → Product
val routerConfig : RouterConfig
def synchronized [T0] (arg0: ⇒ T0): T0

Attributes
final
Definition Classes
AnyRef
def toString (): String

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

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

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

Attributes
final
Definition Classes
AnyRef
Annotations
@throws()
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.
def withCreator (c: Creator[Actor]): Props

Returns a new Props with the specified creator set.
Returns a new Props with the specified creator set.
Java API.
def withCreator (c: ⇒ Actor): Props

Returns a new Props with the specified creator set.
Returns a new Props with the specified creator set.
Scala API.
def withDeploy (d: Deploy): Props

Returns a new Props with the specified deployment configuration.
def withDispatcher (d: String): Props

Returns a new Props with the specified dispatcher set.
def withRouter (r: RouterConfig): Props

Returns a new Props with the specified router config set.

Deprecated Value Members

def productElements : Iterator[Any]

Definition Classes
Product
Annotations
@deprecated
Deprecated
use productIterator instead

Props

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

Instance Constructors

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

new Props (factory: UntypedActorFactory)

new Props ()

new Props (creator: () ⇒ Actor, dispatcher: String, routerConfig: RouterConfig, deploy: Deploy)

Value Members

def != (arg0: AnyRef): Boolean

def != (arg0: Any): Boolean

def ## (): Int

def == (arg0: AnyRef): Boolean

def == (arg0: Any): Boolean

def asInstanceOf [T0] : T0

def canEqual (arg0: Any): Boolean

def clone (): AnyRef

val creator : () ⇒ Actor

val deploy : Deploy

val dispatcher : String

def eq (arg0: AnyRef): Boolean

def equals (arg0: Any): Boolean

def finalize (): Unit

def getClass (): java.lang.Class[_]

def hashCode (): Int

def isInstanceOf [T0] : Boolean

def ne (arg0: AnyRef): Boolean

def notify (): Unit

def notifyAll (): Unit

def productArity : Int

def productElement (arg0: Int): Any

def productIterator : Iterator[Any]

def productPrefix : String

val routerConfig : RouterConfig

def synchronized [T0] (arg0: ⇒ T0): T0

def toString (): String

def wait (): Unit

def wait (arg0: Long, arg1: Int): Unit

def wait (arg0: Long): Unit

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

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

def withCreator (c: ⇒ Actor): Props

def withDeploy (d: Deploy): Props

def withDispatcher (d: String): Props

def withRouter (r: RouterConfig): Props

Deprecated Value Members

def productElements : Iterator[Any]

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any