Interface IActorRefProvider

The Actor Reference Provider API.

The factory used to produce and create IActorRef instances used inside an ActorSystem.

Namespace: Akka.Actor

Assembly: Akka.dll

Syntax

public interface IActorRefProvider

Properties

DeadLetters

Gets the dead letters.

Declaration

IActorRef DeadLetters { get; }

Property Value

Type	Description
IActorRef

DefaultAddress

Gets the external address of the default transport.

Declaration

Address DefaultAddress { get; }

Property Value

Type	Description
Address

Deployer

Gets the deployer.

Declaration

Deployer Deployer { get; }

Property Value

Type	Description
Deployer

Guardian

Gets the supervisor used for all top-level user actors.

Declaration

LocalActorRef Guardian { get; }

Property Value

Type	Description
LocalActorRef

IgnoreRef

Declaration

IActorRef IgnoreRef { get; }

Property Value

Type	Description
IActorRef

RootGuardian

Reference to the supervisor of guardian and systemGuardian; this is exposed so that the ActorSystemImpl can use it as lookupRoot, i.e. for anchoring absolute actor look-ups.

Declaration

IInternalActorRef RootGuardian { get; }

Property Value

Type	Description
IInternalActorRef

RootPath

Gets the root path for all actors within this actor system, not including any remote address information.

Declaration

ActorPath RootPath { get; }

Property Value

Type	Description
ActorPath

Settings

Gets the settings.

Declaration

Settings Settings { get; }

Property Value

Type	Description
Settings

SystemGuardian

Gets the supervisor used for all top-level system actors.

Declaration

LocalActorRef SystemGuardian { get; }

Property Value

Type	Description
LocalActorRef

TempContainer

Returns the actor reference representing the "/temp" path.

Declaration

IInternalActorRef TempContainer { get; }

Property Value

Type	Description
IInternalActorRef

TerminationTask

This Future is completed upon termination of this IActorRefProvider, which is usually initiated by stopping the guardian via Stop(IActorRef).

Declaration

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

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

GetExternalAddressFor(Address)

Obtain the address which is to be used within sender references when sending to the given other address or none if the other address cannot be reached from this system (i.e. no means of communication known; no attempt is made to verify actual reachability).

Declaration

Address GetExternalAddressFor(Address address)

Parameters

Type	Name	Description
Address	address	TBD

Returns

Type	Description
Address	TBD

Init(ActorSystemImpl)

Initialization of an ActorRefProvider happens in two steps: first construction of the object with settings, eventStream, etc. and then—when the ActorSystem is constructed—the second phase during which actors may be created (e.g. the guardians).

Declaration

void Init(ActorSystemImpl system)

Parameters

Type	Name	Description
ActorSystemImpl	system	TBD

RegisterTempActor(IInternalActorRef, ActorPath)

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

Declaration

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!

ResolveActorRef(ActorPath)

Get the actor reference for a specified path. If no such actor exists, it will be (equivalent to) a dead letter reference.

Declaration

IActorRef ResolveActorRef(ActorPath actorPath)

Parameters

Type	Name	Description
ActorPath	actorPath	TBD

Returns

Type	Description
IActorRef	TBD

ResolveActorRef(string)

Get the actor reference for a specified path. If no such actor exists, it will be (equivalent to) a dead letter reference.

Declaration

IActorRef ResolveActorRef(string path)

Parameters

Type	Name	Description
string	path	TBD

Returns

Type	Description
IActorRef	TBD

RootGuardianAt(Address)

Reference to the supervisor of guardian and systemGuardian at the specified address; this is exposed so that the ActorRefFactory can use it as lookupRoot, i.e. for anchoring absolute actor selections.

Declaration

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

ActorPath TempPath()

Returns

Type	Description
ActorPath	TBD

UnregisterTempActor(ActorPath)

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

Declaration

void UnregisterTempActor(ActorPath path)

Parameters

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

Extension Methods

ObjectExtensions.IsDefaultForType<T>(T)

ObjectExtensions.AsOption<T>(T)

Extensions.AsInstanceOf<T>(object)