Class LocalActorRef

A local actor reference that exists inside the same process as the current ActorSystem.

Inheritance
object
ActorRefBase
InternalActorRefBase
ActorRefWithCell
LocalActorRef
InternalTestActorRef
Implements
Inherited Members
Namespace: Akka.Actor
Assembly: Akka.dll
Syntax
public class LocalActorRef : ActorRefWithCell, IActorRef, ICanTell, IEquatable<IActorRef>, IComparable<IActorRef>, ISurrogated, IComparable

Constructors

| Edit this page View Source

LocalActorRef(ActorSystemImpl, Props, MessageDispatcher, MailboxType, IInternalActorRef, ActorPath)

TBD

Declaration
public LocalActorRef(ActorSystemImpl system, Props props, MessageDispatcher dispatcher, MailboxType mailboxType, IInternalActorRef supervisor, ActorPath path)
Parameters
Type Name Description
ActorSystemImpl system

TBD
Props props

TBD
MessageDispatcher dispatcher

TBD
MailboxType mailboxType

TBD
IInternalActorRef supervisor

TBD
ActorPath path

TBD

Properties

| Edit this page View Source

Cell

Declaration
public ActorCell Cell { get; }
Property Value
Type Description
ActorCell
| Edit this page View Source

Children

An iterable collection of the actor's children. Empty if there are none.

Declaration
public override IEnumerable<IActorRef> Children { get; }
Property Value
Type Description
IEnumerable<IActorRef>
Overrides
Akka.Actor.ActorRefWithCell.Children
| Edit this page View Source

Dispatcher

The MessageDispatcher this actor will use to execute its message-processing.

Declaration
protected MessageDispatcher Dispatcher { get; }
Property Value
Type Description
MessageDispatcher
| Edit this page View Source

IsLocal

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override bool IsLocal { get; }
Property Value
Type Description
bool
Overrides
Akka.Actor.InternalActorRefBase.IsLocal
| Edit this page View Source

IsTerminated

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override bool IsTerminated { get; }
Property Value
Type Description
bool
Overrides
Akka.Actor.InternalActorRefBase.IsTerminated
| Edit this page View Source

MailboxType

The type of mailbox used by this actor

Declaration
protected MailboxType MailboxType { get; }
Property Value
Type Description
MailboxType
| Edit this page View Source

Parent

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override IInternalActorRef Parent { get; }
Property Value
Type Description
IInternalActorRef
Overrides
Akka.Actor.InternalActorRefBase.Parent
| Edit this page View Source

Path

TBD

Declaration
public override ActorPath Path { get; }
Property Value
Type Description
ActorPath
Overrides
| Edit this page View Source

Props

The Props used to create this actor.

Declaration
protected Props Props { get; }
Property Value
Type Description
Props
| Edit this page View Source

Provider

The Actor Reference Provider API.

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

Declaration
public override IActorRefProvider Provider { get; }
Property Value
Type Description
IActorRefProvider
Overrides
Akka.Actor.InternalActorRefBase.Provider
| Edit this page View Source

Supervisor

The actor's supervisor, typically its parent.

Declaration
protected IInternalActorRef Supervisor { get; }
Property Value
Type Description
IInternalActorRef
| Edit this page View Source

System

The ActorSystem to which this actor ref belongs.

Declaration
protected ActorSystem System { get; }
Property Value
Type Description
ActorSystem
| Edit this page View Source

Underlying

The ActorCell.

Declaration
public override ICell Underlying { get; }
Property Value
Type Description
ICell
Overrides
Akka.Actor.ActorRefWithCell.Underlying

Methods

| Edit this page View Source

GetChild(IReadOnlyList<string>)

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override IActorRef GetChild(IReadOnlyList<string> name)
Parameters
Type Name Description
IReadOnlyList<string> name
Returns
Type Description
IActorRef
Overrides
| Edit this page View Source

GetSingleChild(string)

Fetches a reference to a single child actor.

Declaration
public override IInternalActorRef GetSingleChild(string name)
Parameters
Type Name Description
string name

The name of the child we're trying to fetch.
Returns
Type Description
IInternalActorRef

If the child exists, it returns the child actor. Otherwise, we return Nobody.
Overrides
| Edit this page View Source

NewActorCell(ActorSystemImpl, IInternalActorRef, Props, MessageDispatcher, IInternalActorRef)

Creates a new ActorCell instance.

Declaration
protected virtual ActorCell NewActorCell(ActorSystemImpl system, IInternalActorRef self, Props props, MessageDispatcher dispatcher, IInternalActorRef supervisor)
Parameters
Type Name Description
ActorSystemImpl system

The actor system to which this actor belongs.
IInternalActorRef self

The reference to this actor.
Props props

The Props used to create this actor.
MessageDispatcher dispatcher

The dispatcher this actor will run on.
IInternalActorRef supervisor

A reference to this actor's supervising actor, typically its parent.
Returns
Type Description
ActorCell

A reference to an uninitialized actor cell.
| Edit this page View Source

Restart(Exception)

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override void Restart(Exception cause)
Parameters
Type Name Description
Exception cause
Overrides
| Edit this page View Source

Resume(Exception)

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override void Resume(Exception causedByFailure = null)
Parameters
Type Name Description
Exception causedByFailure
Overrides
| Edit this page View Source

SendSystemMessage(ISystemMessage)

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override void SendSystemMessage(ISystemMessage message)
Parameters
Type Name Description
ISystemMessage message
Overrides
| Edit this page View Source

Start()

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override void Start()
Overrides
Akka.Actor.InternalActorRefBase.Start()
| Edit this page View Source

Stop()

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override void Stop()
Overrides
Akka.Actor.InternalActorRefBase.Stop()
| Edit this page View Source

Suspend()

INTERNAL API.

Used by built-in IActorRef implementations for handling internal operations that are not exposed directly to end-users.

Declaration
public override void Suspend()
Overrides
Akka.Actor.InternalActorRefBase.Suspend()
| Edit this page View Source

TellInternal(object, IActorRef)

TBD

Declaration
protected override void TellInternal(object message, IActorRef sender)
Parameters
Type Name Description
object message

TBD
IActorRef sender

TBD
Overrides

Implements

Extension Methods