Class PhobosDeploy

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

Inheritance
object
Deploy
PhobosDeploy
Implements
Inherited Members
Namespace: Phobos.Actor
Assembly: Phobos.Actor.dll
Syntax
public class PhobosDeploy : Deploy, IEquatable<Deploy>, ISurrogated

Constructors

PhobosDeploy()

Initializes a new instance of the PhobosDeploy class.

Declaration
public PhobosDeploy()

PhobosDeploy(Deploy)

Initializes a new instance of the PhobosDeploy class.

Declaration
public PhobosDeploy(Deploy d)
Parameters
Type Name Description
Deploy d

The underlying Deploy that will be wrapped into a new PhobosDeploy instance.
Remarks

This copy constructor is intended to be used to help give users access to the fluent interface for building PhobosDeploy instances.

PhobosDeploy(Deploy, PhobosActorSettings)

Initializes a new instance of the PhobosDeploy class.

Declaration
public PhobosDeploy(Deploy d, PhobosActorSettings settings)
Parameters
Type Name Description
Deploy d

The underlying Deploy that will be wrapped into a new PhobosDeploy instance.
PhobosActorSettings settings

The instrumentation settings used for this actor.
Remarks

This copy constructor is intended to be used to help give users access to the fluent interface for building PhobosDeploy instances.

PhobosDeploy(PhobosActorSettings)

Initializes a new instance of the PhobosDeploy class.

Declaration
public PhobosDeploy(PhobosActorSettings settings)
Parameters
Type Name Description
PhobosActorSettings settings

The instrumentation settings used for this actor.

PhobosDeploy(string, Config, RouterConfig, Scope, string, string, PhobosActorSettings)

Initializes a new instance of the PhobosDeploy class.

Declaration
public PhobosDeploy(string path, Config config, RouterConfig routerConfig, Scope scope, string dispatcher, string mailbox, PhobosActorSettings settings)
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.
PhobosActorSettings settings

The instrumentation settings used for this actor.

PhobosDeploy(string, Config, RouterConfig, Scope, string, string, PhobosActorSettings, int)

Initializes a new instance of the PhobosDeploy class.

Declaration
public PhobosDeploy(string path, Config config, RouterConfig routerConfig, Scope scope, string dispatcher, string mailbox, PhobosActorSettings settings, 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.
PhobosActorSettings settings

The instrumentation settings used for this actor.
int stashCapacity

The stash capacity. New setting added as of Akka.NET v1.5.4.

Properties

InstrumentationSettings

The instrumentation settings for a specific actor

Declaration
public PhobosActorSettings InstrumentationSettings { get; }
Property Value
Type Description
PhobosActorSettings

Methods

WithDispatcher(string)

Creates a new Deploy with a given dispatcher.

note

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

Declaration
public override 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.
Overrides

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 override 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.
Overrides

WithInstrumentation(PhobosActorSettings)

Declaration
public PhobosDeploy WithInstrumentation(PhobosActorSettings settings)
Parameters
Type Name Description
PhobosActorSettings settings
Returns
Type Description
PhobosDeploy

WithMailbox(string)

Creates a new Deploy with a given mailbox.

note

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

Declaration
public override 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.
Overrides

WithRouterConfig(RouterConfig)

Creates a new Deploy with a given RouterConfig.

note

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

Declaration
public override 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.
Overrides

WithScope(Scope)

Creates a new Deploy with a given Scope.

note

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

Declaration
public override 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.
Overrides

WithStashCapacity(int)

Creates a new Deploy with a given stashSize.

note

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

Declaration
public override Deploy WithStashCapacity(int stashSize)
Parameters
Type Name Description
int stashSize
Returns
Type Description
Deploy

A new Deploy with a given stashSize.
Overrides

Implements

Extension Methods