Documentation [skip ci]

Signed-off-by: Gabriele Santomaggio <[email protected]>

Author: Gsantomaggio

RabbitMQ.Stream.Client/RawConsumer.cs

@@ -10,10 +10,24 @@
 
 namespace RabbitMQ.Stream.Client
 {
+    /// <summary>
+    /// MessageContext contains message metadata information
+    /// 
+    /// </summary>
     public struct MessageContext
     {
+        /// <summary>
+        /// Message offset inside the log
+        /// each single message has its own offset
+        /// </summary>
         public ulong Offset { get; }
 
+        /// <summary>
+        /// The timestamp of the message chunk.
+        /// A chunk (usually) contains multiple messages
+        /// The timestamp is the same for all messages in the chunk.
+        /// A chunk is simply a batch of messages. 
+        /// </summary>
         public TimeSpan Timestamp { get; }
 
         public MessageContext(ulong offset, TimeSpan timestamp)

RabbitMQ.Stream.Client/Reliable/Consumer.cs

@@ -23,12 +23,42 @@ public record ConsumerConfig : ReliableConfig
     // </summary>
     public string ClientProvidedName { get; set; } = "dotnet-stream-conusmer";
 
+    // <summary>
+    // Function where the consumer receives the messages.
+    // Parameters:
+    // - string: the stream name where the message was published
+    // - MessageContext: Context of the message, see <see cref="RawConsumer.MessageContext"/>
+    // - Message: the decode message received
+    // </summary>
     public Func<string, RawConsumer, MessageContext, Message, Task> MessageHandler { get; set; }
 
+    // <summary>
+    // Enable the SuperStream stream feature.
+    // See also: https://blog.rabbitmq.com/posts/2022/07/rabbitmq-3-11-feature-preview-super-streams
+    // Parameters:
     public bool IsSuperStream { get; set; }
+    
+    // <summary>
+    // The offset is the place in the stream where the consumer starts consuming from. The possible values for the offset parameter are the following:
+    // - OffsetTypeFirst: starting from the first available offset. If the stream has not been truncated, this means the beginning of the stream (offset 0).
+    // - OffsetTypeLast: starting from the end of the stream and returning the last chunk of messages immediately (if the stream is not empty).
+    // - OffsetTypeNext: starting from the next offset to be written. Contrary to OffsetTypeLast, consuming with OffsetTypeNext will not return anything if no-one is publishing to the stream. The broker will start sending messages to the consumer when messages are published to the stream.
+    // - OffsetTypeOffset(offset): starting from the specified offset. 0 means consuming from the beginning of the stream (first messages). The client can also specify any number, for example the offset where it left off in a previous incarnation of the application.
+    // - OffsetTypeTimeStamp(timestamp): starting from the messages stored after the specified timestamp.
+    // </summary>
     public IOffsetType OffsetSpec { get; set; } = new OffsetTypeNext();
 
+    // <summary>
+    // When the single active consumer feature is enabled for several consumer instances sharing the same stream and name, only one of these instances will be active at a time and so will receive messages.
+    // The other instances will be idle.
+    // </summary>
     public bool IsSingleActiveConsumer { get; set; } = false;
+    
+    // <summary>
+    // The broker notifies a consumer that becomes active before dispatching messages to it. 
+    // With ConsumerUpdateListener the consumer can decide where to start consuming from.
+    // The event is raised only in case of single active consumer.
+    // </summary>
     public Func<string, string, bool, Task<IOffsetType>> ConsumerUpdateListener { get; set; } = null;
 
     public ConsumerConfig(StreamSystem streamSystem, string stream) : base(streamSystem, stream)