Class LocalActorRefProvider

Class LocalActorRefProvider. This class cannot be inherited.

Inheritance

object

LocalActorRefProvider

Implements

IActorRefProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public sealed class LocalActorRefProvider : IActorRefProvider

Constructors

LocalActorRefProvider(string, Settings, EventStream)

Initializes a new instance of the LocalActorRefProvider class.

Declaration

public LocalActorRefProvider(string systemName, Settings settings, EventStream eventStream)

Parameters

Type	Name	Description
string	systemName	The name of the actor system.
Settings	settings	The settings for the actor system.
EventStream	eventStream	The event stream for logging and events.

LocalActorRefProvider(string, Settings, EventStream, Deployer, Func<ActorPath, IInternalActorRef>)

Initializes a new instance of the LocalActorRefProvider class with custom deployer and dead letters factory.

Declaration

public LocalActorRefProvider(string systemName, Settings settings, EventStream eventStream, Deployer deployer, Func<ActorPath, IInternalActorRef> deadLettersFactory)

Parameters

Type	Name	Description
string	systemName	The name of the actor system.
Settings	settings	The settings for the actor system.
EventStream	eventStream	The event stream for logging and events.
Deployer	deployer	The deployer instance to use.
Func<ActorPath, IInternalActorRef>	deadLettersFactory	A factory for creating dead letter actor references.

Properties

DeadLetters

Gets the dead letters actor reference for this provider.

Declaration

public IActorRef DeadLetters { get; }

Property Value

Type	Description
IActorRef

DefaultAddress

The default address of the current ActorSystem.

Declaration

public Address DefaultAddress { get; }

Property Value

Type	Description
Address

Deployer

Gets the deployer instance for this provider.

Declaration

public Deployer Deployer { get; }

Property Value

Type	Description
Deployer

EventStream

Gets the event stream for this provider.

Declaration

public EventStream EventStream { get; }

Property Value

Type	Description
EventStream

Guardian

Gets the user guardian actor reference.

Declaration

public LocalActorRef Guardian { get; }

Property Value

Type	Description
LocalActorRef

IgnoreRef

Gets the ignore actor reference for this provider.

Declaration

public IActorRef IgnoreRef { get; }

Property Value

Type	Description
IActorRef

Log

The built-in logger for the ActorRefProvider

Declaration

public ILoggingAdapter Log { get; }

Property Value

Type	Description
ILoggingAdapter

RootGuardian

Gets the root guardian actor reference.

Declaration

public IInternalActorRef RootGuardian { get; }

Property Value

Type	Description
IInternalActorRef

RootPath

Gets the root path for this actor system.

Declaration

public ActorPath RootPath { get; }

Property Value

Type	Description
ActorPath

SerializationInformation

INTERNAL API.

Declaration

public Information SerializationInformation { get; }

Property Value

Type	Description
Information

Settings

Gets the settings for this provider.

Declaration

public Settings Settings { get; }

Property Value

Type	Description
Settings

SystemGuardian

Gets the system guardian actor reference.

Declaration

public LocalActorRef SystemGuardian { get; }

Property Value

Type	Description
LocalActorRef

TempContainer

Gets the temporary container for this provider.

Declaration

public IInternalActorRef TempContainer { get; }

Property Value

Type	Description
IInternalActorRef

TerminationTask

Gets the termination task for this provider.

Declaration

public Task TerminationTask { get; }

Property Value

Type	Description
Task

Methods

ActorOf(ActorSystemImpl, Props, IInternalActorRef, ActorPath, bool, Deploy, bool, bool)

Actor factory with create-only semantics: will create an actor as described by props with the given supervisor and path (may be different in case of remote supervision). If systemService is true, deployment is bypassed (local-only). If a value fordeploy is passed in, it should be regarded as taking precedence over the nominally applicable settings, but it should be overridable from external configuration; the lookup of the latter can be suppressed by setting "lookupDeploy" to "false".

Declaration

public IInternalActorRef ActorOf(ActorSystemImpl system, Props props, IInternalActorRef supervisor, ActorPath path, bool systemService, Deploy deploy, bool lookupDeploy, bool async)

Parameters

Type	Name	Description
ActorSystemImpl	system	TBD
Props	props	TBD
IInternalActorRef	supervisor	TBD
ActorPath	path	TBD
bool	systemService	TBD
Deploy	deploy	TBD
bool	lookupDeploy	TBD
bool	async	TBD

Returns

Type	Description
IInternalActorRef	TBD

Exceptions

Type

Condition

ConfigurationException

This exception can be thrown for a number of reasons. The following are some examples: non-routers The dispatcher in the given props is not configured for the given path. or There was a configuration problem while creating the given path with the dispatcher and mailbox from the given props routers The dispatcher in the given props is not configured for routees of the given path or The dispatcher in the given props is not configured for router of the given path or $There was a configuration problem while creating the given path with router dispatcher and mailbox and routee dispatcher and mailbox.

CreateFutureRef<T>(TaskCompletionSource<T>)

Automatically generates a FutureActorRef<T> with a temporary path.

Declaration

public FutureActorRef<T> CreateFutureRef<T>(TaskCompletionSource<T> tcs)

Parameters

Type	Name	Description
TaskCompletionSource<T>	tcs	A typed TaskCompletionSource<TResult>

Returns

Type	Description
FutureActorRef<T>	A new, single-use FutureActorRef<T> instance.

Type Parameters

Name	Description
T	The type of output this FutureActorRef<T> expects.

Remarks

Does not call RegisterTempActor(IInternalActorRef, ActorPath) or UnregisterTempActor(ActorPath).

GetExternalAddressFor(Address)

TBD

Declaration

public Address GetExternalAddressFor(Address address)

Parameters

Type	Name	Description
Address	address	TBD

Returns

Type	Description
Address	TBD

Init(ActorSystemImpl)

Initializes the ActorRefProvider

Declaration

public void Init(ActorSystemImpl system)

Parameters

Type	Name	Description
ActorSystemImpl	system	The concrete ActorSystem implementation.

RegisterExtraName(string, IInternalActorRef)

Higher-level providers (or extensions) might want to register new synthetic top-level paths for doing special stuff. This is the way to do just that. Just be careful to complete all this before Start() finishes, or before you start your own auto-spawned actors.

Declaration

public void RegisterExtraName(string name, IInternalActorRef actor)

Parameters

Type	Name	Description
string	name	TBD
IInternalActorRef	actor	TBD

RegisterTempActor(IInternalActorRef, ActorPath)

Registers an actorRef at a path returned by TempPath(); do NOT pass in any other path.

Declaration

public void RegisterTempActor(IInternalActorRef actorRef, ActorPath path)

Parameters

Type	Name	Description
IInternalActorRef	actorRef	The actor reference.
ActorPath	path	A path returned by TempPath(). Do NOT pass in any other path!

Exceptions

Type	Condition
InvalidOperationException	This exception is thrown if the given path is not on the temp path.

ResolveActorRef(ActorPath)

Resolves the actor reference.

Declaration

public IActorRef ResolveActorRef(ActorPath path)

Parameters

Type	Name	Description
ActorPath	path	The actor path.

Returns

Type	Description
IActorRef	ActorRef.

ResolveActorRef(string)

TBD

Declaration

public IActorRef ResolveActorRef(string path)

Parameters

Type	Name	Description
string	path	TBD

Returns

Type	Description
IActorRef	TBD

RootGuardianAt(Address)

TBD

Declaration

public IActorRef RootGuardianAt(Address address)

Parameters

Type	Name	Description
Address	address	TBD

Returns

Type	Description
IActorRef	TBD

TempPath()

Generates and returns a unique actor path below "/temp".

Declaration

public ActorPath TempPath()

Returns

Type	Description
ActorPath	A unique temporary actor path.

UnregisterTempActor(ActorPath)

Unregister a temporary actor (i.e. obtained from TempPath()); do NOT pass in any other path.

Declaration

public void UnregisterTempActor(ActorPath path)

Parameters

Type	Name	Description
ActorPath	path	A path returned by TempPath(). Do NOT pass in any other path!

Exceptions

Type	Condition
InvalidOperationException	This exception is thrown if the given path is not on the temp path.

Implements

IActorRefProvider

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)