Class LocalActorRef

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

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

Constructors

| Improve this Doc 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
Akka.Actor.IInternalActorRef supervisor

TBD
ActorPath path

TBD

Properties

| Improve this Doc View Source

Cell

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

Children

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

Dispatcher

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

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

IsLocal

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

IsTerminated

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

MailboxType

The type of mailbox used by this actor

Declaration
protected MailboxType MailboxType { get; }
Property Value
Type Description
MailboxType
| Improve this Doc View Source

Parent

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

Path

TBD

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

Props

The Props used to create this actor.

Declaration
protected Props Props { get; }
Property Value
Type Description
Props
| Improve this Doc 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
| Improve this Doc View Source

Supervisor

The actor's supervisor, typically its parent.

Declaration
protected IInternalActorRef Supervisor { get; }
Property Value
Type Description
Akka.Actor.IInternalActorRef
| Improve this Doc View Source

System

The ActorSystem to which this actor ref belongs.

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

Underlying

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

Methods

| Improve this Doc View Source

GetChild(IReadOnlyList<String>)

Declaration
public override IActorRef GetChild(IReadOnlyList<string> name)
Parameters
Type Name Description
IReadOnlyList<String> name
Returns
Type Description
IActorRef
Overrides
Akka.Actor.InternalActorRefBase.GetChild(System.Collections.Generic.IReadOnlyList<System.String>)
| Improve this Doc View Source

GetSingleChild(String)

Declaration
public override IInternalActorRef GetSingleChild(string name)
Parameters
Type Name Description
String name
Returns
Type Description
Akka.Actor.IInternalActorRef
Overrides
Akka.Actor.ActorRefWithCell.GetSingleChild(System.String)
| Improve this Doc 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.
Akka.Actor.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.
Akka.Actor.IInternalActorRef supervisor

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

A reference to an uninitialized actor cell.
| Improve this Doc View Source

Restart(Exception)

Declaration
public override void Restart(Exception cause)
Parameters
Type Name Description
Exception cause
Overrides
Akka.Actor.InternalActorRefBase.Restart(System.Exception)
| Improve this Doc View Source

Resume(Exception)

Declaration
public override void Resume(Exception causedByFailure = null)
Parameters
Type Name Description
Exception causedByFailure
Overrides
Akka.Actor.InternalActorRefBase.Resume(System.Exception)
| Improve this Doc View Source

SendSystemMessage(ISystemMessage)

Declaration
public override void SendSystemMessage(ISystemMessage message)
Parameters
Type Name Description
ISystemMessage message
Overrides
Akka.Actor.InternalActorRefBase.SendSystemMessage(Akka.Dispatch.SysMsg.ISystemMessage)
| Improve this Doc View Source

Start()

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

Stop()

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

Suspend()

Declaration
public override void Suspend()
Overrides
Akka.Actor.InternalActorRefBase.Suspend()
| Improve this Doc 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