Class RemoteActorRef

RemoteActorRef - used to provide a local handle to an actor running in a remote process.

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

Constructors

| Edit this page View Source

RemoteActorRef(RemoteTransport, Address, ActorPath, IInternalActorRef, Props, Deploy)

Initializes a new instance of the RemoteActorRef class.

Declaration
public RemoteActorRef(RemoteTransport remote, Address localAddressToUse, ActorPath path, IInternalActorRef parent, Props props, Deploy deploy)
Parameters
Type Name Description
RemoteTransport remote

The remote.
Address localAddressToUse

The local address to use.
ActorPath path

The path.
IInternalActorRef parent

The parent.
Props props

The props.
Deploy deploy

The deploy.

Properties

| 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

Obsolete. Use Watch or Receive<>

Declaration
[Obsolete("Use Context.Watch and Receive<Terminated> [1.1.0]")]
public override bool IsTerminated { get; }
Property Value
Type Description
bool
Overrides
Akka.Actor.InternalActorRefBase.IsTerminated
| Edit this page View Source

LocalAddressToUse

Gets the local address to use.

Declaration
public Address LocalAddressToUse { get; }
Property Value
Type Description
Address

The local address to use.
| Edit this page View Source

Parent

Gets the parent.

Declaration
public override IInternalActorRef Parent { get; }
Property Value
Type Description
IInternalActorRef

The parent.
Overrides
Akka.Actor.InternalActorRefBase.Parent
| Edit this page View Source

Path

An actor reference. Acts as a handle to an actor. Used to send messages to an actor, whether an actor is local or remote. If you receive a reference to an actor, that actor is guaranteed to have existed at some point in the past. However, an actor can always be terminated in the future.

If you want to be notified about an actor terminating, call IActorContext.Watch on this actor and you'll receive a Terminated message when the actor dies or if it is already dead.

Declaration
public override ActorPath Path { get; }
Property Value
Type Description
ActorPath
Overrides
Remarks

Actor references can be serialized and passed over the network.

| Edit this page View Source

Provider

Gets the provider.

Declaration
public override IActorRefProvider Provider { get; }
Property Value
Type Description
IActorRefProvider

The provider.
Overrides
Akka.Actor.InternalActorRefBase.Provider

Methods

| Edit this page View Source

GetChild(IReadOnlyList<string>)

Gets the child.

Declaration
public override IActorRef GetChild(IReadOnlyList<string> name)
Parameters
Type Name Description
IReadOnlyList<string> name

The name.
Returns
Type Description
IActorRef

ActorRef.
Overrides
Exceptions
Type Condition
NotImplementedException

TBD
| Edit this page View Source

IsWatchIntercepted(IActorRef, IActorRef)

Determine if a Watch/Unwatch message must be handled by the RemoteWatcher actor, or sent to this RemoteActorRef.

Declaration
public bool IsWatchIntercepted(IActorRef watchee, IActorRef watcher)
Parameters
Type Name Description
IActorRef watchee

The actor being watched.
IActorRef watcher

The actor watching.
Returns
Type Description
bool

TBD
| Edit this page View Source

Restart(Exception)

Restarts the specified cause.

Declaration
public override void Restart(Exception cause)
Parameters
Type Name Description
Exception cause

The cause.
Overrides
| Edit this page View Source

Resume(Exception)

Resumes the specified caused by failure.

Declaration
public override void Resume(Exception causedByFailure = null)
Parameters
Type Name Description
Exception causedByFailure

The caused by failure.
Overrides
| Edit this page View Source

SendSystemMessage(ISystemMessage)

Sends the system message.

Declaration
public override void SendSystemMessage(ISystemMessage message)
Parameters
Type Name Description
ISystemMessage message

The message.
Overrides
| Edit this page View Source

Start()

Starts this instance.

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

Stop()

Stops this instance.

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

Suspend()

Suspends this instance.

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

TellInternal(object, IActorRef)

Tells the internal.

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

The message.
IActorRef sender

The sender.
Overrides
Exceptions
Type Condition
InvalidMessageException

TBD

Implements

Extension Methods