Props Class

Props Class

Props is a configuration object using in creating an [[Actor]]; it is immutable, so it is thread-safe and fully shareable. Examples on C# API:

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

SystemObject
Akka.ActorProps
Akka.ActorTerminatedProps

Namespace: Akka.Actor
Assembly: Akka (in Akka.dll) Version: 0.8.0.0 (0.8.0.0)

Syntax

C++

Copy

public class Props : IEquatable<Props>

Public Class Props
	Implements IEquatable(Of Props)

public ref class Props : IEquatable<Props^>

type Props =  
    class
        interface IEquatable<Props>
    end

The Props type exposes the following members.

Constructors

	Name	Description
	Props	Initializes a new instance of the Props class.
	Props(Type)	Initializes a new instance of the Props class.
	Props(Props)	Initializes a new instance of the Props class from a copy.
	Props(Type, Object)	Initializes a new instance of the Props class.
	Props(Type, SupervisorStrategy, IEnumerableObject)	Initializes a new instance of the Props class.
	Props(Type, SupervisorStrategy, Object)	Initializes a new instance of the Props class.
	Props(Deploy, Type, IEnumerableObject)	Initializes a new instance of the Props class.
	Props(Deploy, Type, Object)	Initializes a new instance of the Props class.

Top

Methods

	Name	Description
	Copy	Copies this instance.
	Create(Type, Object)	Creates the specified type.
	CreateTActor(Object)	Creates this instance.
	CreateTActor(SupervisorStrategy)	Creates this instance.
	CreateTActor(ExpressionFuncTActor, SupervisorStrategy)	Creates the specified factory.
	CreateByTProducer	Creates an actor by an actor producer
	Equals(Object)	(Overrides ObjectEquals(Object).)
	Equals(Props)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	(Overrides ObjectGetHashCode.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NewActor	Create a new actor instance. This method is only useful when called during actor creation by the ActorSystem.
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WithDeploy	Returns a new Props with the specified deployment configuration.
	WithDispatcher	Returns a new Props with the specified dispatcher set.
	WithMailbox	Returns a new Props with the specified mailbox set.
	WithRouter	Returns a new Props with the specified router config set.
	WithSupervisorStrategy	Returns a new Props with the specified supervisor strategy set.

Top

Extension Methods

	Name	Description
	AsInstanceOfT	(Defined by Extensions.)
	Match	Matches the specified target. (Defined by PatternMatch.)

Top

Fields

	Name	Description
	None	The none

Top

Properties

	Name	Description
	Arguments	Gets the arguments.
	Deploy	Gets or sets the deploy.
	Dispatcher	Gets or sets the dispatcher.
	Empty	A Props instance whose creator will create an actor that doesn't respond to any message
	Mailbox	Gets or sets the mailbox.
	RouterConfig	Gets or sets the router configuration.
	SupervisorStrategy	Gets or sets the supervisor strategy.
	Type	Gets the type.
	TypeName

Top

Reference

Akka.Actor Namespace