IInternalActorRef Interface

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

Namespace: Akka.Actor
Assembly: Akka (in Akka.dll) Version: 1.2.3.42 (1.2.3.42)

Syntax

Copy

public interface IInternalActorRef : IActorRef, 
	ICanTell, IEquatable<IActorRef>, IComparable<IActorRef>, 
	ISurrogated, IComparable, IActorRefScope

type IInternalActorRef =  
    interface
        interface IActorRef
        interface ICanTell
        interface IEquatable<IActorRef>
        interface IComparable<IActorRef>
        interface ISurrogated
        interface IComparable
        interface IActorRefScope
    end

The IInternalActorRef type exposes the following members.

Properties

	Name	Description
	IsLocal	Returns true if the actor is local to this ActorSystem. Returns false if the actor is remote. (Inherited from IActorRefScope.)
	IsTerminated	Obsolete. Obsolete. Use [!:Akka.Actor.UntypedActor.Context.Watch(IActorRef)] or Receive<>
	Parent	The parent of this actor.
	Path	The path of this actor. Can be used to extract information about whether or not this actor is local or remote. (Inherited from IActorRef.)
	Provider	The IActorRefProvider used by the ActorSystem to which this actor belongs.

Top

Methods

	Name	Description
	CompareTo(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.)
	CompareTo(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.)
	Equals	Indicates whether the current object is equal to another object of the same type. (Inherited from IEquatableIActorRef.)
	GetChild	Obtain a child given the paths element to that actor, by possibly traversing the actor tree or looking it up at some provider-specific location. A path element of ".." signifies the parent, a trailing "" element must be disregarded. If the requested path does not exist, returns Nobody.
	Restart	Restart the actor.
	Resume	Resumes an actor if it has been suspended.
	SendSystemMessage(ISystemMessage)	Sends an ISystemMessage to the underlying actor.
	SendSystemMessage(ISystemMessage, IActorRef)	Obsolete. Obsolete. Use SendSystemMessage(ISystemMessage) instead.
	Start	Start a newly created actor.
	Stop	Stop the actor. Terminates it permanently.
	Suspend	Suspend the actor. Actor will not process any more messages until Resume(Exception) is called.
	Tell	Asynchronously delivers a message to this IActorRef or ActorSelection in a non-blocking fashion. Uses "at most once" delivery semantics. (Inherited from ICanTell.)
	ToSurrogate	TBD (Inherited from ISurrogated.)

Top

Extension Methods

	Name	Description
	Ask(Object, NullableTimeSpan)	Overloaded. TBD (Defined by Futures.)
	Ask(Object, CancellationToken)	Overloaded. TBD (Defined by Futures.)
	Ask(Object, NullableTimeSpan, CancellationToken)	Overloaded. TBD (Defined by Futures.)
	AskT(Object, NullableTimeSpan)	Overloaded. TBD (Defined by Futures.)
	AskT(Object, CancellationToken)	Overloaded. TBD (Defined by Futures.)
	AskT(Object, NullableTimeSpan, CancellationToken)	Overloaded. TBD (Defined by Futures.)
	Forward	Forwards the message using the current Sender (Defined by ActorRefImplicitSenderExtensions.)
	GracefulStop(TimeSpan)	Overloaded. TBD (Defined by GracefulStopSupport.)
	GracefulStop(TimeSpan, Object)	Overloaded. TBD (Defined by GracefulStopSupport.)
	IsNobody	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.)
	Tell	Asynchronously tells a message to an IActorRef. (Defined by ActorRefImplicitSenderExtensions.)

Top

Reference

Akka.Actor Namespace