Class PhobosDeploy

Extends the Deploy class to include additional data about monitoring, tracing, and other instrumentation bits.

Inheritance

System.Object

Deploy

PhobosDeploy

Implements

System.IEquatable<Deploy>

ISurrogated

Inherited Members

Deploy.Local

Deploy.NoDispatcherGiven

Deploy.NoMailboxGiven

Deploy.NoStashSize

Deploy.NoScopeGiven

Deploy.None

Deploy.Equals(Deploy)

Deploy.ToSurrogate(ActorSystem)

Deploy.Path

Deploy.Config

Deploy.RouterConfig

Deploy.Scope

Deploy.Mailbox

Deploy.Dispatcher

Deploy.StashCapacity

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

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
System.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.
System.String	dispatcher	The dispatcher used in this deployment.
System.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, Int32)

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
System.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.
System.String	dispatcher	The dispatcher used in this deployment.
System.String	mailbox	The mailbox configured for the actor used in this deployment.
PhobosActorSettings	settings	The instrumentation settings used for this actor.
System.Int32	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)

Declaration

public override Deploy WithDispatcher(string dispatcher)

Parameters

Type	Name	Description
System.String	dispatcher

Returns

Type	Description
Deploy

Overrides

Deploy.WithDispatcher(String)

WithFallback(Deploy)

Declaration

public override Deploy WithFallback(Deploy other)

Parameters

Type	Name	Description
Deploy	other

Returns

Type	Description
Deploy

Overrides

Deploy.WithFallback(Deploy)

WithInstrumentation(PhobosActorSettings)

Declaration

public PhobosDeploy WithInstrumentation(PhobosActorSettings settings)

Parameters

Type	Name	Description
PhobosActorSettings	settings

Returns

Type	Description
PhobosDeploy

WithMailbox(String)

Declaration

public override Deploy WithMailbox(string mailbox)

Parameters

Type	Name	Description
System.String	mailbox

Returns

Type	Description
Deploy

Overrides

Deploy.WithMailbox(String)

WithRouterConfig(RouterConfig)

Declaration

public override Deploy WithRouterConfig(RouterConfig routerConfig)

Parameters

Type	Name	Description
RouterConfig	routerConfig

Returns

Type	Description
Deploy

Overrides

Deploy.WithRouterConfig(RouterConfig)

WithScope(Scope)

Declaration

public override Deploy WithScope(Scope scope)

Parameters

Type	Name	Description
Scope	scope

Returns

Type	Description
Deploy

Overrides

Deploy.WithScope(Scope)

WithStashCapacity(Int32)

Declaration

public override Deploy WithStashCapacity(int stashSize)

Parameters

Type	Name	Description
System.Int32	stashSize

Returns

Type	Description
Deploy

Overrides

Deploy.WithStashCapacity(Int32)

Implements

System.IEquatable<T>

ISurrogated

Extension Methods

PropsExtensions.WithInstrumentation(Deploy, PhobosActorSettings)