Search Results for

    Show / Hide Table of Contents

    Class ActorRefBase

    Base implementation for IActorRef implementations.

    Inheritance
    object
    ActorRefBase
    Implements
    IActorRef
    ICanTell
    IEquatable<IActorRef>
    IComparable<IActorRef>
    ISurrogated
    IComparable
    Inherited Members
    object.Equals(object, object)
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Akka.Actor
    Assembly: Akka.dll
    Syntax
    public abstract class ActorRefBase : IActorRef, ICanTell, IEquatable<IActorRef>, IComparable<IActorRef>, ISurrogated, IComparable

    Properties

    | Edit this page View Source

    Path

    TBD

    Declaration
    public abstract ActorPath Path { get; }
    Property Value
    Type Description
    ActorPath

    Methods

    | Edit this page View Source

    CompareTo(IActorRef)

    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.

    Declaration
    public int CompareTo(IActorRef other)
    Parameters
    Type Name Description
    IActorRef other

    An object to compare with this instance.

    Returns
    Type Description
    int

    A value that indicates the relative order of the objects being compared. The return value has these meanings:

    Value Meaning
    Less than zero This instance precedes other in the sort order.
    Zero This instance occurs in the same position in the sort order as other.
    Greater than zero This instance follows other in the sort order.
    | Edit this page View Source

    CompareTo(object)

    Declaration
    public int CompareTo(object obj)
    Parameters
    Type Name Description
    object obj
    Returns
    Type Description
    int
    Exceptions
    Type Condition
    ArgumentException

    This exception is thrown if the given obj isn't an IActorRef.

    | Edit this page View Source

    Equals(IActorRef)

    Checks equality between this instance and another object.

    Declaration
    public bool Equals(IActorRef other)
    Parameters
    Type Name Description
    IActorRef other
    Returns
    Type Description
    bool

    true if this IActorRef instance have the same reference as the other instance, if this ActorPath of this IActorRef instance is equal to the other instance, and other is not null; otherwise false.

    | Edit this page View Source

    Equals(object)

    Determines whether the specified object is equal to the current object.

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    object obj

    The object to compare with the current object.

    Returns
    Type Description
    bool

    true if the specified object is equal to the current object; otherwise, false.

    Overrides
    object.Equals(object)
    | Edit this page View Source

    GetHashCode()

    Serves as the default hash function.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    int

    A hash code for the current object.

    Overrides
    object.GetHashCode()
    | Edit this page View Source

    Tell(object, IActorRef)

    TBD

    Declaration
    public void Tell(object message, IActorRef sender)
    Parameters
    Type Name Description
    object message

    TBD

    IActorRef sender

    TBD

    | Edit this page View Source

    TellInternal(object, IActorRef)

    TBD

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

    TBD

    IActorRef sender

    TBD

    | Edit this page View Source

    ToString()

    Returns a string that represents the current object.

    Declaration
    public override string ToString()
    Returns
    Type Description
    string

    A string that represents the current object.

    Overrides
    object.ToString()
    | Edit this page View Source

    ToSurrogate(ActorSystem)

    Creates a surrogate representation of the current ActorRefBase.

    Declaration
    public virtual ISurrogate ToSurrogate(ActorSystem system)
    Parameters
    Type Name Description
    ActorSystem system

    The actor system that references this ActorRefBase.

    Returns
    Type Description
    ISurrogate

    The surrogate representation of the current ActorRefBase.

    Implements

    IActorRef
    ICanTell
    IEquatable<T>
    IComparable<T>
    ISurrogated
    IComparable

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    ActorRefExtensions.GetOrElse(IActorRef, Func<IActorRef>)
    ActorRefExtensions.IsNobody(IActorRef)
    ActorRefImplicitSenderExtensions.Forward(IActorRef, object)
    ActorRefImplicitSenderExtensions.Tell(IActorRef, object)
    GracefulStopSupport.GracefulStop(IActorRef, TimeSpan)
    GracefulStopSupport.GracefulStop(IActorRef, TimeSpan, object)
    WatchAsyncSupport.WatchAsync(IActorRef, CancellationToken)
    Futures.Ask(ICanTell, object, TimeSpan?)
    Futures.Ask(ICanTell, object, TimeSpan?, CancellationToken)
    Futures.Ask(ICanTell, object, CancellationToken)
    Futures.Ask<T>(ICanTell, Func<IActorRef, object>, TimeSpan?, CancellationToken)
    Futures.Ask<T>(ICanTell, object, TimeSpan?)
    Futures.Ask<T>(ICanTell, object, TimeSpan?, CancellationToken)
    Futures.Ask<T>(ICanTell, object, CancellationToken)
    Extensions.AsInstanceOf<T>(object)
    In this article
    • githubEdit this page
    • View Source
    Back to top
    Contribute
    • Project Chat
    • Discussion Forum
    • Source Code
    Support
    • Akka.NET Support Plans
    • Akka.NET Observability Tools
    • Akka.NET Training & Consulting
    Maintained By
    • Petabridge - The Akka.NET Company
    • Learn Akka.NET