Updated the signature of Method SaveData(MyData data, TimeSpan ttl);

Author: m3nax

examples/Actor/ActorClient/Program.cs

@@ -32,10 +32,14 @@ public class Program
         /// <returns>A <see cref="Task"/> representing the asynchronous operation.</returns>
         public static async Task Main(string[] args)
         {
-            var data = new MyData()
+            var data = new MyDataWithTTL()
             {
-                PropertyA = "ValueA",
-                PropertyB = "ValueB",
+                MyData = new MyData
+                {
+                    PropertyA = "ValueA",
+                    PropertyB = "ValueB",
+                },
+                TTL = TimeSpan.FromMinutes(10),
             };
 
             // Create an actor Id.
@@ -46,7 +50,7 @@ public static async Task Main(string[] args)
             var proxy = ActorProxy.Create<IDemoActor>(actorId, "DemoActor");
 
             Console.WriteLine("Making call using actor proxy to save data.");
-            await proxy.SaveData(data, TimeSpan.FromMinutes(10));
+            await proxy.SaveData(data);
             Console.WriteLine("Making call using actor proxy to get data.");
             var receivedData = await proxy.GetData();
             Console.WriteLine($"Received data is {receivedData}.");
@@ -103,7 +107,7 @@ public static async Task Main(string[] args)
             await proxy.UnregisterTimer();
             Console.WriteLine("Deregistering reminder. Reminders are durable and would not stop until an explicit deregistration or the actor is deleted.");
             await proxy.UnregisterReminder();
-            
+
             Console.WriteLine("Registering reminder with repetitions - The reminder will repeat 3 times.");
             await proxy.RegisterReminderWithRepetitions(3);
             Console.WriteLine("Waiting so the reminder can be triggered");

examples/Actor/DemoActor/DemoActor.cs

@@ -57,50 +57,59 @@ public DemoActor(
             }
         }
 
-        public async Task SaveData(MyData data, TimeSpan ttl)
+        /// <inheritdoc/>
+        public async Task SaveData(MyDataWithTTL data)
         {
             Console.WriteLine($"This is Actor id {this.Id} with data {data}.");
 
             // Set State using StateManager, state is saved after the method execution.
-            await this.StateManager.SetStateAsync<MyData>(StateName, data, ttl);
+            await this.StateManager.SetStateAsync<MyData>(StateName, data.MyData, data.TTL);
         }
 
+        /// <inheritdoc/>
         public Task<MyData> GetData()
         {
             // Get state using StateManager.
             return this.StateManager.GetStateAsync<MyData>(StateName);
         }
 
+        /// <inheritdoc/>
         public Task TestThrowException()
         {
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc/>
         public Task TestNoArgumentNoReturnType()
         {
             return Task.CompletedTask;
         }
 
+        /// <inheritdoc/>
         public async Task RegisterReminder()
         {
             await this.RegisterReminderAsync("TestReminder", null, TimeSpan.FromSeconds(5), TimeSpan.FromSeconds(5));
         }
 
+        /// <inheritdoc/>
         public async Task RegisterReminderWithTtl(TimeSpan ttl)
         {
             await this.RegisterReminderAsync("TestReminder", null, TimeSpan.FromSeconds(5), TimeSpan.FromSeconds(5), ttl);
         }
 
+        /// <inheritdoc/>
         public async Task RegisterReminderWithRepetitions(int repetitions)
         {
             await this.RegisterReminderAsync("TestReminder", null, TimeSpan.FromSeconds(0), TimeSpan.FromSeconds(1), repetitions);
         }
 
+        /// <inheritdoc/>
         public async Task RegisterReminderWithTtlAndRepetitions(TimeSpan ttl, int repetitions)
         {
             await this.RegisterReminderAsync("TestReminder", null, TimeSpan.FromSeconds(0), TimeSpan.FromSeconds(1), repetitions, ttl);
         }
 
+        /// <inheritdoc/>
         public async Task<ActorReminderData> GetReminder()
         {
             var reminder = await this.GetReminderAsync("TestReminder");
@@ -115,11 +124,13 @@ public async Task<ActorReminderData> GetReminder()
                 : null;
         }
 
+        /// <inheritdoc/>
         public Task UnregisterReminder()
         {
             return this.UnregisterReminderAsync("TestReminder");
         }
 
+        /// <inheritdoc/>
         public async Task ReceiveReminderAsync(string reminderName, byte[] state, TimeSpan dueTime, TimeSpan period)
         {
             // This method is invoked when an actor reminder is fired.
@@ -147,6 +158,7 @@ public Task RegisterTimer()
             return this.RegisterTimerAsync("TestTimer", nameof(this.TimerCallback), serializedTimerParams, TimeSpan.FromSeconds(3), TimeSpan.FromSeconds(3));
         }
 
+        /// <inheritdoc/>
         public Task RegisterTimerWithTtl(TimeSpan ttl)
         {
             var timerParams = new TimerParams
@@ -159,6 +171,7 @@ public Task RegisterTimerWithTtl(TimeSpan ttl)
             return this.RegisterTimerAsync("TestTimer", nameof(this.TimerCallback), serializedTimerParams, TimeSpan.FromSeconds(3), TimeSpan.FromSeconds(3), ttl);
         }
 
+        /// <inheritdoc/>
         public Task UnregisterTimer()
         {
             return this.UnregisterTimerAsync("TestTimer");
@@ -195,6 +208,7 @@ public async Task TimerCallback(byte[] data)
             Console.WriteLine("Timer parameter2: " + timerParams.StringParam);
         }
 
+        /// <inheritdoc/>
         public async Task<AccountBalance> GetAccountBalance()
         {
             var starting = new AccountBalance()
@@ -207,6 +221,7 @@ public async Task<AccountBalance> GetAccountBalance()
             return balance;
         }
 
+        /// <inheritdoc/>
         public async Task Withdraw(WithdrawRequest withdraw)
         {
             var starting = new AccountBalance()

examples/Actor/IDemoActor/IDemoActor.cs

@@ -16,7 +16,6 @@ namespace IDemoActorInterface
     using System;
     using System.Threading.Tasks;
     using Dapr.Actors;
-    using Dapr.Actors.Runtime;
 
     /// <summary>
     /// Interface for Actor method.
@@ -26,10 +25,9 @@ public interface IDemoActor : IActor
         /// <summary>
         /// Method to save data.
         /// </summary>
-        /// <param name="data">DAta to save.</param>
-        /// <param name="ttl">TTL of state key.</param>
+        /// <param name="data">Data to save with its TTL.</param>
         /// <returns>A task that represents the asynchronous save operation.</returns>
-        Task SaveData(MyData data, TimeSpan ttl);
+        Task SaveData(MyDataWithTTL data);
 
         /// <summary>
         /// Method to get data.
@@ -80,14 +78,14 @@ public interface IDemoActor : IActor
         /// <param name="ttl">Optional TimeSpan that dictates when the timer expires.</param>
         /// <returns>A task that represents the asynchronous save operation.</returns>
         Task RegisterTimerWithTtl(TimeSpan ttl);
-        
+
         /// <summary>
         /// Registers a reminder with repetitions.
         /// </summary>
         /// <param name="repetitions">The number of repetitions for which the reminder should be invoked.</param>
         /// <returns>A task that represents the asynchronous save operation.</returns>
         Task RegisterReminderWithRepetitions(int repetitions);
-        
+
         /// <summary>
         /// Registers a reminder with ttl and repetitions.
         /// </summary>
@@ -134,6 +132,25 @@ public override string ToString()
         }
     }
 
+    /// <summary>
+    /// Variant of MyData with TTL.
+    /// </summary>
+    public class MyDataWithTTL
+    {
+        /// <summary>
+        /// Gets or sets the MyData value.
+        /// </summary>
+        public MyData MyData { get; set; }
+
+        /// <summary>
+        /// Duration for which the state is valid.
+        /// </summary>
+        public TimeSpan TTL { get; set; }
+    }
+
+    /// <summary>
+    /// Object to hold reminder data.
+    /// </summary>
     public class ActorReminderData
     {
         public string Name { get; set; }