Class Deploy

This class represents a configuration object used in the deployment of an actor.

Inheritance

object

Deploy

Implements

IEquatable<Deploy>

ISurrogated

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public class Deploy : IEquatable<Deploy>, ISurrogated

Constructors

| Edit this page View Source

Deploy()

Initializes a new instance of the Deploy class.

Declaration

public Deploy()

| Edit this page View Source

Deploy(Scope)

Initializes a new instance of the Deploy class.

Declaration

public Deploy(Scope scope)

Parameters

Type	Name	Description
Scope	scope	The scope to bind to this deployment.

| Edit this page View Source

Deploy(RouterConfig)

Initializes a new instance of the Deploy class.

Declaration

public Deploy(RouterConfig routerConfig)

Parameters

Type	Name	Description
RouterConfig	routerConfig	The router to use for this deployment.

| Edit this page View Source

Deploy(RouterConfig, Scope)

Initializes a new instance of the Deploy class.

Declaration

public Deploy(RouterConfig routerConfig, Scope scope)

Parameters

Type	Name	Description
RouterConfig	routerConfig	The router to use for this deployment.
Scope	scope	The scope to bind to this deployment.

| Edit this page View Source

Deploy(string, Scope)

Initializes a new instance of the Deploy class.

Declaration

public Deploy(string path, Scope scope)

Parameters

Type	Name	Description
string	path	The actor path associated with this deployment.
Scope	scope	The scope to bind to this deployment.

| Edit this page View Source

Deploy(string, Config, RouterConfig, Scope, string)

Initializes a new instance of the Deploy class.

Declaration

public Deploy(string path, Config config, RouterConfig routerConfig, Scope scope, string dispatcher)

Parameters

Type	Name	Description
string	path	The path to deploy the actor.
Config	config	The configuration used when deploying the actor.
RouterConfig	routerConfig	The router used in this deployment.
Scope	scope	The scope to bind to this deployment.
string	dispatcher	The dispatcher used in this deployment.

| Edit this page View Source

Deploy(string, Config, RouterConfig, Scope, string, string)

Initializes a new instance of the Deploy class.

Declaration

public Deploy(string path, Config config, RouterConfig routerConfig, Scope scope, string dispatcher, string mailbox)

Parameters

Type	Name	Description
string	path	The path to deploy the actor.
Config	config	The configuration used when deploying the actor.
RouterConfig	routerConfig	The router used in this deployment.
Scope	scope	The scope to bind to this deployment.
string	dispatcher	The dispatcher used in this deployment.
string	mailbox	The mailbox configured for the actor used in this deployment.

| Edit this page View Source

Deploy(string, Config, RouterConfig, Scope, string, string, int)

Initializes a new instance of the Deploy class.

Declaration

public Deploy(string path, Config config, RouterConfig routerConfig, Scope scope, string dispatcher, string mailbox, int stashCapacity)

Parameters

Type	Name	Description
string	path	The path to deploy the actor.
Config	config	The configuration used when deploying the actor.
RouterConfig	routerConfig	The router used in this deployment.
Scope	scope	The scope to bind to this deployment.
string	dispatcher	The dispatcher used in this deployment.
string	mailbox	The mailbox configured for the actor used in this deployment.
int	stashCapacity	If this actor is using a stash, the bounded stash size.

Fields

| Edit this page View Source

Local

A deployment configuration that is bound to the Local scope.

Declaration

public static readonly Deploy Local

Field Value

Type	Description
Deploy

| Edit this page View Source

NoDispatcherGiven

This deployment does not have a dispatcher associated with it.

Declaration

public static readonly string NoDispatcherGiven

Field Value

Type	Description
string

| Edit this page View Source

NoMailboxGiven

This deployment does not have a mailbox associated with it.

Declaration

public static readonly string NoMailboxGiven

Field Value

Type	Description
string

| Edit this page View Source

NoScopeGiven

This deployment has an unspecified scope associated with it.

Declaration

public static readonly Scope NoScopeGiven

Field Value

Type	Description
Scope

| Edit this page View Source

NoStashSize

No stash size set.

Declaration

public const int NoStashSize = -1

Field Value

Type	Description
int

| Edit this page View Source

None

A deployment configuration where none of the options have been configured.

Declaration

public static readonly Deploy None

Field Value

Type	Description
Deploy

Properties

| Edit this page View Source

Config

The configuration used for this deployment.

Declaration

public Config Config { get; }

Property Value

Type	Description
Config

| Edit this page View Source

Dispatcher

The dispatcher used in this deployment.

Declaration

public string Dispatcher { get; }

Property Value

Type	Description
string

| Edit this page View Source

Mailbox

The mailbox configured for the actor used in this deployment.

Declaration

public string Mailbox { get; }

Property Value

Type	Description
string

| Edit this page View Source

Path

The path where the actor is deployed.

Declaration

public string Path { get; }

Property Value

Type	Description
string

| Edit this page View Source

RouterConfig

The router used for this deployment.

Declaration

public RouterConfig RouterConfig { get; }

Property Value

Type	Description
RouterConfig

| Edit this page View Source

Scope

The scope bound to this deployment.

Declaration

public Scope Scope { get; }

Property Value

Type	Description
Scope

| Edit this page View Source

StashCapacity

The size of the IStash, if there's one configured.

Declaration

public int StashCapacity { get; }

Property Value

Type	Description
int

Remarks

Defaults to -1, which means an unbounded stash.

Methods

| Edit this page View Source

Equals(Deploy)

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

Declaration

public bool Equals(Deploy other)

Parameters

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

Returns

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

| Edit this page View Source

ToSurrogate(ActorSystem)

Creates a surrogate representation of the current Deploy.

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 Deploy.

| Edit this page View Source

WithDispatcher(string)

Creates a new Deploy with a given dispatcher.

note

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

Declaration

public virtual Deploy WithDispatcher(string dispatcher)

Parameters

Type	Name	Description
string	dispatcher	The dispatcher used to configure the new Deploy.

Returns

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

| Edit this page View Source

WithFallback(Deploy)

Creates a new Deploy from this deployment using another Deploy to backfill options that might be missing from this deployment.

note

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

Declaration

public virtual Deploy WithFallback(Deploy other)

Parameters

Type	Name	Description
Deploy	other	The Deploy used for fallback configuration.

Returns

Type	Description
Deploy	A new Deploy using `other` for fallback configuration.

| Edit this page View Source

WithMailbox(string)

Creates a new Deploy with a given mailbox.

note

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

Declaration

public virtual Deploy WithMailbox(string mailbox)

Parameters

Type	Name	Description
string	mailbox	The mailbox used to configure the new Deploy.

Returns

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

| Edit this page View Source

WithRouterConfig(RouterConfig)

Creates a new Deploy with a given RouterConfig.

note

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

Declaration

public virtual Deploy WithRouterConfig(RouterConfig routerConfig)

Parameters

Type	Name	Description
RouterConfig	routerConfig	The RouterConfig used to configure the new Deploy.

Returns

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

| Edit this page View Source

WithScope(Scope)

Creates a new Deploy with a given Scope.

note

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

Declaration

public virtual Deploy WithScope(Scope scope)

Parameters

Type	Name	Description
Scope	scope	The Scope used to configure the new Deploy.

Returns

Type	Description
Deploy	A new Deploy with the provided `scope`.

| Edit this page View Source

WithStashCapacity(int)

Creates a new Deploy with a given stashSize.

note

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

Declaration

public virtual Deploy WithStashCapacity(int stashSize)

Parameters

Type	Name	Description
int	stashSize

Returns

Type	Description
Deploy	A new Deploy with a given `stashSize`.

Implements

IEquatable<T>

ISurrogated

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)