Search Results for

    Show / Hide Table of Contents

    Interface IStash

    Public interface used to expose stash capabilities to user-level actors

    Namespace: Akka.Actor
    Assembly: Akka.dll
    Syntax
    public interface IStash

    Properties

    | Edit this page View Source

    Capacity

    The total capacity of the stash.

    Declaration
    int Capacity { get; }
    Property Value
    Type Description
    int
    | Edit this page View Source

    Count

    The number of messages currently inside the stash.

    Declaration
    int Count { get; }
    Property Value
    Type Description
    int
    | Edit this page View Source

    IsEmpty

    Returns true when Count is zero.

    Declaration
    bool IsEmpty { get; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    IsFull

    When using a bounded stash, this returns true when the stash is full.

    Declaration
    bool IsFull { get; }
    Property Value
    Type Description
    bool
    Remarks

    Always returns false when using an unbounded stash.

    | Edit this page View Source

    NonEmpty

    Returns true when Count is greater than zero.

    Declaration
    bool NonEmpty { get; }
    Property Value
    Type Description
    bool

    Methods

    | Edit this page View Source

    ClearStash()

    Returns all messages and clears the stash. The stash is guaranteed to be empty afterwards.

    Declaration
    IEnumerable<Envelope> ClearStash()
    Returns
    Type Description
    IEnumerable<Envelope>

    The previous stashed messages.

    | Edit this page View Source

    Prepend(IEnumerable<Envelope>)

    Prepend a set of envelopes to the front of the stash.

    Declaration
    void Prepend(IEnumerable<Envelope> envelopes)
    Parameters
    Type Name Description
    IEnumerable<Envelope> envelopes

    TBD

    | Edit this page View Source

    Stash()

    Stashes the current message (the message that the actor received last)

    Declaration
    void Stash()
    | Edit this page View Source

    Unstash()

    Unstash the oldest message in the stash and prepends it to the actor's mailbox. The message is removed from the stash.

    Declaration
    void Unstash()
    | Edit this page View Source

    UnstashAll()

    Unstashes all messages by prepending them to the actor's mailbox. The stash is guaranteed to be empty afterwards.

    Declaration
    void UnstashAll()
    | Edit this page View Source

    UnstashAll(Func<Envelope, bool>)

    Unstashes all messages selected by the predicate function. Other messages are discarded. The stash is guaranteed to be empty afterwards.

    Declaration
    void UnstashAll(Func<Envelope, bool> predicate)
    Parameters
    Type Name Description
    Func<Envelope, bool> predicate

    TBD

    Extension Methods

    ObjectExtensions.IsDefaultForType<T>(T)
    ObjectExtensions.AsOption<T>(T)
    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