Class Props

This class represents a configuration object used in creating an actor. It is immutable and thus thread-safe.

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

Object

Props

TerminatedProps

Implements

IEquatable<Props>

ISurrogated

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public class Props : IEquatable<Props>, ISurrogated

Constructors

| Improve this Doc View Source

Props()

Initializes a new instance of the Props class.

Declaration

protected Props()

| Improve this Doc View Source

Props(Deploy, Type, IEnumerable<Object>)

Initializes a new instance of the Props class.

Declaration

public Props(Deploy deploy, Type type, IEnumerable<object> args)

Parameters

Type	Name	Description
Deploy	deploy	The configuration used to deploy the actor.
Type	type	The type of the actor to create.
IEnumerable<Object>	args	The arguments needed to create the actor.

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if Props is not instantiated with an actor type.

| Improve this Doc View Source

Props(Deploy, Type, Object[])

Initializes a new instance of the Props class.

Declaration

public Props(Deploy deploy, Type type, params object[] args)

Parameters

Type	Name	Description
Deploy	deploy	The configuration used to deploy the actor.
Type	type	The type of the actor to create.
Object[]	args	The arguments needed to create the actor.

Exceptions

Type	Condition
ArgumentException	This exception is thrown if `type` is an unknown actor producer.

| Improve this Doc View Source

Props(Props)

Initializes a new instance of the Props class.

Declaration

protected Props(Props copy)

Parameters

Type	Name	Description
Props	copy	The object that is being cloned.

| Improve this Doc View Source

Props(Type)

Initializes a new instance of the Props class.

note

Props configured in this way uses the Deploy deployer.

Declaration

public Props(Type type)

Parameters

Type	Name	Description
Type	type	The type of the actor to create.

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if Props is not instantiated with an actor type.

| Improve this Doc View Source

Props(Type, SupervisorStrategy, IEnumerable<Object>)

Initializes a new instance of the Props class.

Declaration

public Props(Type type, SupervisorStrategy supervisorStrategy, IEnumerable<object> args)

Parameters

Type	Name	Description
Type	type	The type of the actor to create.
SupervisorStrategy	supervisorStrategy	The supervisor strategy used to manage the actor.
IEnumerable<Object>	args	The arguments needed to create the actor.

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if Props is not instantiated with an actor type.

| Improve this Doc View Source

Props(Type, SupervisorStrategy, Object[])

Initializes a new instance of the Props class.

Declaration

public Props(Type type, SupervisorStrategy supervisorStrategy, params object[] args)

Parameters

Type	Name	Description
Type	type	The type of the actor to create.
SupervisorStrategy	supervisorStrategy	The supervisor strategy used to manage the actor.
Object[]	args	The arguments needed to create the actor.

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if Props is not instantiated with an actor type.

| Improve this Doc View Source

Props(Type, Object[])

Initializes a new instance of the Props class.

note

Props configured in this way uses the Deploy deployer.

Declaration

public Props(Type type, object[] args)

Parameters

Type	Name	Description
Type	type	The type of the actor to create.
Object[]	args	The arguments needed to create the actor.

Exceptions

Type	Condition
ArgumentNullException	This exception is thrown if Props is not instantiated with an actor type.

Fields

| Improve this Doc View Source

None

A pre-configured Props that doesn't create actors.

note

The value of this field is null.

Declaration

public static readonly Props None

Field Value

Type	Description
Props

Properties

| Improve this Doc View Source

Arguments

The arguments needed to create the actor.

Declaration

public object[] Arguments { get; }

Property Value

Type	Description
Object[]

| Improve this Doc View Source

Deploy

The configuration used to deploy the actor.

Declaration

public Deploy Deploy { get; protected set; }

Property Value

Type	Description
Deploy

| Improve this Doc View Source

Dispatcher

The dispatcher used in the deployment of the actor.

Declaration

[JsonIgnore]
public string Dispatcher { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

Empty

A pre-configured Props that creates an actor that doesn't respond to messages.

Declaration

public static Props Empty { get; }

Property Value

Type	Description
Props

| Improve this Doc View Source

Mailbox

The mailbox used in the deployment of the actor.

Declaration

[JsonIgnore]
public string Mailbox { get; }

Property Value

Type	Description
String

| Improve this Doc View Source

RouterConfig

The router used in the deployment of the actor.

Declaration

[JsonIgnore]
public RouterConfig RouterConfig { get; }

Property Value

Type	Description
RouterConfig

| Improve this Doc View Source

SupervisorStrategy

The supervisor strategy used to manage the actor.

Declaration

public SupervisorStrategy SupervisorStrategy { get; protected set; }

Property Value

Type	Description
SupervisorStrategy

| Improve this Doc View Source

Type

The type of the actor that is created.

Declaration

[JsonIgnore]
public Type Type { get; }

Property Value

Type	Description
Type

| Improve this Doc View Source

TypeName

The assembly qualified name of the type of the actor that is created.

Declaration

public string TypeName { get; }

Property Value

Type	Description
String

Methods

| Improve this Doc View Source

Copy()

Creates a copy of the current instance.

Declaration

protected virtual Props Copy()

Returns

Type	Description
Props	The newly created Props

| Improve this Doc View Source

Create(Type, Object[])

Creates an actor of a specified type.

Declaration

public static Props Create(Type type, params object[] args)

Parameters

Type	Name	Description
Type	type	The type of the actor to create.
Object[]	args	The arguments needed to create the actor.

Returns

Type	Description
Props	The newly created Props.

Exceptions

Type	Condition
ArgumentNullException	Props must be instantiated with an actor type.

| Improve this Doc View Source

Create<TActor>(SupervisorStrategy)

Creates an actor using a specified supervisor strategy.

Declaration

public static Props Create<TActor>(SupervisorStrategy supervisorStrategy)
    where TActor : ActorBase, new()

Parameters

Type	Name	Description
SupervisorStrategy	supervisorStrategy	The supervisor strategy used to manage the actor.

Returns

Type	Description
Props	The newly created Props.

Type Parameters

Name	Description
TActor	The type of the actor to create.

| Improve this Doc View Source

Create<TActor>(Expression<Func<TActor>>, SupervisorStrategy)

Creates an actor using a specified lambda expression.

Declaration

public static Props Create<TActor>(Expression<Func<TActor>> factory, SupervisorStrategy supervisorStrategy = null)
    where TActor : ActorBase

Parameters

Type	Name	Description
Expression<Func<TActor>>	factory	The lambda expression used to create the actor.
SupervisorStrategy	supervisorStrategy	Optional: The supervisor strategy used to manage the actor.

Returns

Type	Description
Props	The newly created Props.

Type Parameters

Name	Description
TActor	The type of the actor to create.

Exceptions

Type	Condition
ArgumentException	The create function must be a 'new T (args)' expression

| Improve this Doc View Source

Create<TActor>(Object[])

Creates an actor using the given arguments.

Declaration

public static Props Create<TActor>(params object[] args)
    where TActor : ActorBase

Parameters

Type	Name	Description
Object[]	args	The arguments needed to create the actor.

Returns

Type	Description
Props	The newly created Props.

Type Parameters

Name	Description
TActor	The type of the actor to create.

| Improve this Doc View Source

CreateBy(IIndirectActorProducer, Object[])

Creates an actor using a specified actor producer.

Declaration

public static Props CreateBy(IIndirectActorProducer producer, params object[] args)

Parameters

Type	Name	Description
IIndirectActorProducer	producer	The actor producer that will be used to create the underlying actor..
Object[]	args	The arguments needed to create the actor.

Returns

Type	Description
Props	The newly created Props.

| Improve this Doc View Source

CreateBy<TProducer>(Object[])

Creates an actor using a specified actor producer.

Declaration

[Obsolete("Do not use this method. Call CreateBy(IIndirectActorProducer, params object[] args) instead")]
public static Props CreateBy<TProducer>(params object[] args)
    where TProducer : class, IIndirectActorProducer

Parameters

Type	Name	Description
Object[]	args	The arguments needed to create the actor.

Returns

Type	Description
Props	The newly created Props.

Type Parameters

Name	Description
TProducer	The type of producer used to create the actor.

| Improve this Doc View Source

Equals(Props)

Indicates whether the current object is equal to another object of the same type.

Declaration

public bool Equals(Props other)

Parameters

Type	Name	Description
Props	other	An object to compare with this object.

Returns

Type	Description
Boolean	`true` if the current object is equal to the `other` parameter; otherwise, `false`.

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

| Improve this Doc View Source

NewActor()

Creates a new actor using the configured actor producer. This method is only useful when called during actor creation by the ActorSystem.

Declaration

public virtual ActorBase NewActor()

Returns

Type	Description
ActorBase	The newly created actor

Exceptions

Type	Condition
TypeLoadException	This exception is thrown if there was an error creating an actor of type Type with the arguments from Arguments.

| Improve this Doc View Source

ToSurrogate(ActorSystem)

Creates a surrogate representation of the current Props.

Declaration

public ISurrogate ToSurrogate(ActorSystem system)

Parameters

Type	Name	Description
ActorSystem	system	The actor system that owns this router.

Returns

Type	Description
ISurrogate	The surrogate representation of the current Props.

| Improve this Doc View Source

WithDeploy(Deploy)

Creates a new Props with a given deployment configuration.

note

This method is immutable and returns a new instance of Props.

Declaration

public Props WithDeploy(Deploy deploy)

Parameters

Type	Name	Description
Deploy	deploy	The configuration used to deploy the actor.

Returns

Type	Description
Props	A new Props with the provided `deploy`.

| Improve this Doc View Source

WithDispatcher(String)

Creates a new Props with a given dispatcher.

note

This method is immutable and returns a new instance of Props.

Declaration

public Props WithDispatcher(string dispatcher)

Parameters

Type	Name	Description
String	dispatcher	The dispatcher used when deploying the actor.

Returns

Type	Description
Props	A new Props with the provided `dispatcher`.

| Improve this Doc View Source

WithMailbox(String)

Creates a new Props with a given mailbox.

note

This method is immutable and returns a new instance of Props.

Declaration

public Props WithMailbox(string mailbox)

Parameters

Type	Name	Description
String	mailbox	The mailbox used when deploying the actor.

Returns

Type	Description
Props	A new Props with the provided `mailbox`.

| Improve this Doc View Source

WithRouter(RouterConfig)

Creates a new Props with a given router.

note

This method is immutable and returns a new instance of Props.

Declaration

public Props WithRouter(RouterConfig routerConfig)

Parameters

Type	Name	Description
RouterConfig	routerConfig	The router used when deploying the actor.

Returns

Type	Description
Props	A new Props with the provided `routerConfig`.

| Improve this Doc View Source

WithStashCapacity(Int32)

Creates a new Props with a given stash size.

note

This method is immutable and returns a new instance of Props.

Declaration

public Props WithStashCapacity(int stashCapacity)

Parameters

Type	Name	Description
Int32	stashCapacity	The stash size to use when creating the actor.

Returns

Type	Description
Props	A new Props with the provided stash size..

Remarks

If the actor doesn't use an IStash or if it uses an IWithUnboundedStash, then this setting will be ignored.

| Improve this Doc View Source

WithSupervisorStrategy(SupervisorStrategy)

Creates a new Props with a given supervisor strategy.

note

This method is immutable and returns a new instance of Props.

Declaration

public Props WithSupervisorStrategy(SupervisorStrategy supervisorStrategy)

Parameters

Type	Name	Description
SupervisorStrategy	supervisorStrategy	The supervisor strategy used to manage the actor.

Returns

Type	Description
Props	A new Props with the provided `supervisorStrategy`.

Implements

IEquatable<T>

ISurrogated

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(Object)