Click or drag to resize
Akka.NETIActorRef Interface
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.

Namespace:  Akka.Actor
Assembly:  Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)
Syntax
Copy
public interface IActorRef : ICanTell, 
	IEquatable<IActorRef>, IComparable<IActorRef>, ISurrogated, 
	IComparable

The IActorRef type exposes the following members.

Properties
  NameDescription
Public propertyPath
The path of this actor. Can be used to extract information about whether or not this actor is local or remote.
Top
Methods
  NameDescription
Public methodCompareTo(Object)
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
(Inherited from IComparable.)
Public methodCompareTo(T)
Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
(Inherited from IComparableIActorRef.)
Public methodEquals
Indicates whether the current object is equal to another object of the same type.
(Inherited from IEquatableIActorRef.)
Public methodTell
Asynchronously delivers a message to this IActorRef or ActorSelection in a non-blocking fashion. Uses "at most once" delivery semantics.
(Inherited from ICanTell.)
Public methodToSurrogate
TBD
(Inherited from ISurrogated.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsk(Object, NullableTimeSpan)Overloaded.
TBD
(Defined by Futures.)
Public Extension MethodAsk(Object, CancellationToken)Overloaded.
TBD
(Defined by Futures.)
Public Extension MethodAsk(Object, NullableTimeSpan, CancellationToken)Overloaded.
TBD
(Defined by Futures.)
Public Extension MethodAskT(Object, NullableTimeSpan)Overloaded.
TBD
(Defined by Futures.)
Public Extension MethodAskT(Object, CancellationToken)Overloaded.
TBD
(Defined by Futures.)
Public Extension MethodAskT(Object, NullableTimeSpan, CancellationToken)Overloaded.
TBD
(Defined by Futures.)
Public Extension MethodForward
Forwards the message using the current Sender
(Defined by ActorRefImplicitSenderExtensions.)
Public Extension MethodGracefulStop(TimeSpan)Overloaded.
TBD
(Defined by GracefulStopSupport.)
Public Extension MethodGracefulStop(TimeSpan, Object)Overloaded.
TBD
(Defined by GracefulStopSupport.)
Public Extension MethodIsNobody
If we call a method such as
Copy
Context.Child(name)
and don't receive a valid result in return, this method will indicate whether or not the actor we received is valid.
(Defined by ActorRefExtensions.)
Public Extension MethodTell
Asynchronously tells a message to an IActorRef.
(Defined by ActorRefImplicitSenderExtensions.)
Top
Remarks
Actor references can be serialized and passed over the network.
See Also