Click or drag to resize
Akka.NETProps Class
This class represents a configuration object used in creating an actor. It is immutable and thus thread-safe.
Examples
Copy
private Props props = Props.Empty();
private Props props = Props.Create(() => new MyActor(arg1, arg2));

private Props otherProps = props.WithDispatcher("dispatcher-id");
private Props otherProps = props.WithDeploy(deployment info);
Inheritance Hierarchy

Namespace:  Akka.Actor
Assembly:  Akka (in Akka.dll) Version: 1.2.3.129 (1.2.3.129)
Syntax
Copy
public class Props : IEquatable<Props>, 
	ISurrogated

The Props type exposes the following members.

Constructors
  NameDescription
Protected methodProps
Initializes a new instance of the Props class.
Public methodProps(Type)
Initializes a new instance of the Props class.
Note Note
Props configured in this way uses the Deploy deployer.
Protected methodProps(Props)
Initializes a new instance of the Props class.
Public methodProps(Type, Object)
Initializes a new instance of the Props class.
Note Note
Props configured in this way uses the Deploy deployer.
Public methodProps(Type, SupervisorStrategy, IEnumerableObject)
Initializes a new instance of the Props class.
Public methodProps(Type, SupervisorStrategy, Object)
Initializes a new instance of the Props class.
Public methodProps(Deploy, Type, IEnumerableObject)
Initializes a new instance of the Props class.
Public methodProps(Deploy, Type, Object)
Initializes a new instance of the Props class.
Top
Properties
  NameDescription
Public propertyArguments
The arguments needed to create the actor.
Public propertyDeploy
The configuration used to deploy the actor.
Public propertyDispatcher
The dispatcher used in the deployment of the actor.
Public propertyStatic memberEmpty
A pre-configured Props that creates an actor that doesn't respond to messages.
Public propertyMailbox
The mailbox used in the deployment of the actor.
Public propertyRouterConfig
The router used in the deployment of the actor.
Public propertySupervisorStrategy
The supervisor strategy used to manage the actor.
Public propertyType
The type of the actor that is created.
Public propertyTypeName
The assembly qualified name of the type of the actor that is created.
Top
Methods
  NameDescription
Protected methodCopy
Creates a copy of the current instance.
Public methodStatic memberCreate(Type, Object)
Creates an actor of a specified type.
Public methodStatic memberCreateTActor(Object)
Creates an actor using the given arguments.
Public methodStatic memberCreateTActor(SupervisorStrategy)
Creates an actor using a specified supervisor strategy.
Public methodStatic memberCreateTActor(ExpressionFuncTActor, SupervisorStrategy)
Creates an actor using a specified lambda expression.
Public methodStatic memberCreateByTProducer
Creates an actor using a specified actor producer.
Public methodEquals(Object)
Determines whether the specified object is equal to the current object.
(Overrides ObjectEquals(Object).)
Public methodEquals(Props)
Indicates whether the current object is equal to another object of the same type.
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Overrides ObjectGetHashCode.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewActor
Creates a new actor using the configured actor producer.
Remarks
This method is only useful when called during actor creation by the ActorSystem.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodToSurrogate
Creates a surrogate representation of the current Props.
Public methodWithDeploy
Creates a new Props with a given deployment configuration.
Note Note
This method is immutable and returns a new instance of Props.
Public methodWithDispatcher
Creates a new Props with a given dispatcher.
Note Note
This method is immutable and returns a new instance of Props.
Public methodWithMailbox
Creates a new Props with a given mailbox.
Note Note
This method is immutable and returns a new instance of Props.
Public methodWithRouter
Creates a new Props with a given router.
Note Note
This method is immutable and returns a new instance of Props.
Public methodWithSupervisorStrategy
Creates a new Props with a given supervisor strategy.
Note Note
This method is immutable and returns a new instance of Props.
Top
Fields
  NameDescription
Public fieldStatic memberNone
A pre-configured Props that doesn't create actors.
Note Note
The value of this field is null.
Top
Extension Methods
See Also