close akkadotnet#6658

Add APIs to track content of Stash

Author: Aaronontheweb

src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.DotNet.verified.txt

@@ -1134,6 +1134,10 @@ namespace Akka.Actor
     }
     public interface IStash
     {
+        int Count { get; }
+        bool IsEmpty { get; }
+        bool IsFull { get; }
+        bool NonEmpty { get; }
         System.Collections.Generic.IEnumerable<Akka.Actor.Envelope> ClearStash();
         void Prepend(System.Collections.Generic.IEnumerable<Akka.Actor.Envelope> envelopes);
         void Stash();
@@ -1933,6 +1937,10 @@ namespace Akka.Actor.Internal
     public abstract class AbstractStash : Akka.Actor.IStash
     {
         protected AbstractStash(Akka.Actor.IActorContext context) { }
+        public int Count { get; }
+        public bool IsEmpty { get; }
+        public bool IsFull { get; }
+        public bool NonEmpty { get; }
         public System.Collections.Generic.IEnumerable<Akka.Actor.Envelope> ClearStash() { }
         public void Prepend(System.Collections.Generic.IEnumerable<Akka.Actor.Envelope> envelopes) { }
         public void Stash() { }

src/core/Akka.API.Tests/verify/CoreAPISpec.ApproveCore.Net.verified.txt

@@ -1132,6 +1132,10 @@ namespace Akka.Actor
     }
     public interface IStash
     {
+        int Count { get; }
+        bool IsEmpty { get; }
+        bool IsFull { get; }
+        bool NonEmpty { get; }
         System.Collections.Generic.IEnumerable<Akka.Actor.Envelope> ClearStash();
         void Prepend(System.Collections.Generic.IEnumerable<Akka.Actor.Envelope> envelopes);
         void Stash();
@@ -1931,6 +1935,10 @@ namespace Akka.Actor.Internal
     public abstract class AbstractStash : Akka.Actor.IStash
     {
         protected AbstractStash(Akka.Actor.IActorContext context) { }
+        public int Count { get; }
+        public bool IsEmpty { get; }
+        public bool IsFull { get; }
+        public bool NonEmpty { get; }
         public System.Collections.Generic.IEnumerable<Akka.Actor.Envelope> ClearStash() { }
         public void Prepend(System.Collections.Generic.IEnumerable<Akka.Actor.Envelope> envelopes) { }
         public void Stash() { }

src/core/Akka.Persistence/Eventsourced.cs

@@ -695,6 +695,11 @@ public void Prepend(IEnumerable<Envelope> envelopes)
             {
                 _userStash.Prepend(envelopes);
             }
+
+            public int Count => _userStash.Count;
+            public bool IsEmpty => _userStash.IsEmpty;
+            public bool NonEmpty => _userStash.NonEmpty;
+            public bool IsFull => _userStash.IsFull;
         }
     }
 }

src/core/Akka/Actor/Stash/IStash.cs

@@ -43,14 +43,37 @@ public interface IStash
         /// Returns all messages and clears the stash.
         /// The stash is guaranteed to be empty afterwards.
         /// </summary>
-        /// <returns>TBD</returns>
+        /// <returns>The previous stashed messages.</returns>
         IEnumerable<Envelope> ClearStash();
 
         /// <summary>
-        /// TBD
+        /// Prepend a set of envelopes to the front of the stash.
         /// </summary>
         /// <param name="envelopes">TBD</param>
         void Prepend(IEnumerable<Envelope> envelopes);
+        
+        /// <summary>
+        /// The number of messages currently inside the stash.
+        /// </summary>
+        public int Count { get; }
+        
+        /// <summary>
+        /// Returns <c>true</c> when <see cref="Count"/> is zero.
+        /// </summary>
+        public bool IsEmpty { get; }
+        
+        /// <summary>
+        /// Returns <c>true</c> when <see cref="Count"/> is greater than zero.
+        /// </summary>
+        public bool NonEmpty { get; }
+        
+        /// <summary>
+        /// When using a bounded stash, this returns <c>true</c> when the stash is full.
+        /// </summary>
+        /// <remarks>
+        /// Always returns <c>false</c> when using an unbounded stash.
+        /// </remarks>
+        public bool IsFull { get; }
     }
 }
 

src/core/Akka/Actor/Stash/Internal/AbstractStash.cs

@@ -189,6 +189,11 @@ public void Prepend(IEnumerable<Envelope> envelopes)
             }
         }
 
+        public int Count => _theStash.Count;
+        public bool IsEmpty => Count == 0;
+        public bool NonEmpty => !IsEmpty;
+        public bool IsFull => _theStash.Count >= _capacity;
+
         /// <summary>
         /// Enqueues <paramref name="msg"/> at the first position in the mailbox. If the message contained in
         /// the envelope is a <see cref="Terminated"/> message, it will be ensured that it can be re-received

src/core/Akka/Dispatch/ISemantics.cs

@@ -11,7 +11,7 @@
 namespace Akka.Dispatch
 {
     /// <summary>
-    /// TBD
+    /// Describes the message queue semantics of a mailbox.
     /// </summary>
     public interface ISemantics
     {