Add docs for message durability (#135)

Havret · Jun 19, 2024 · 74b0196 · 74b0196
1 parent 292805a
commit 74b0196
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/ArtemisNetCoreClient/Message.cs b/src/ArtemisNetCoreClient/Message.cs
@@ -14,6 +14,11 @@ public class Message
 
     public byte Type { get; set; }
 
+    /// <summary>
+    /// Gets or sets a value indicating whether the message is durable or not.
+    /// Durable messages are persisted in permanent storage and will survive server failure or restart.
+    /// Non-durable messages will not survive server failure or restart.
+    /// </summary>
     public bool Durable { get; set; }
 
     /// <summary>

diff --git a/src/ArtemisNetCoreClient/ReceivedMessage.cs b/src/ArtemisNetCoreClient/ReceivedMessage.cs
@@ -14,6 +14,11 @@ public class ReceivedMessage
 
     public required byte Type { get; init; }
 
+    /// <summary>
+    /// Gets a value indicating whether the message is durable or not.
+    /// Durable messages are persisted in permanent storage and will survive server failure or restart.
+    /// Non-durable messages will not survive server failure or restart.
+    /// </summary>
     public required bool Durable { get; init; }
 
     /// <summary>