Improve XML documentation coverage across src modules and sync generated analysis artifacts.

This commit is contained in:
Joseph Doherty
2026-03-14 03:56:58 -04:00
parent ba0d65317a
commit 46ead5ea9f
152 changed files with 2821 additions and 11284 deletions

View File

@@ -25,6 +25,9 @@ public sealed class MqttQoS1Tracker
/// Registers an outgoing QoS 1 message and assigns a packet ID.
/// Returns the assigned packet ID.
/// </summary>
/// <param name="topic">MQTT topic for the outbound message.</param>
/// <param name="payload">Outbound payload bytes.</param>
/// <param name="streamSequence">Optional JetStream stream sequence tied to this delivery.</param>
public ushort Register(string topic, byte[] payload, ulong streamSequence = 0)
{
var id = GetNextPacketId();
@@ -44,6 +47,7 @@ public sealed class MqttQoS1Tracker
/// Acknowledges receipt of a PUBACK for the given packet ID.
/// Returns the pending message if found, or null.
/// </summary>
/// <param name="packetId">MQTT packet identifier from PUBACK.</param>
public QoS1PendingMessage? Acknowledge(ushort packetId)
{
return _pending.TryRemove(packetId, out var msg) ? msg : null;
@@ -69,6 +73,7 @@ public sealed class MqttQoS1Tracker
/// <summary>
/// Checks if a packet ID is pending acknowledgment.
/// </summary>
/// <param name="packetId">MQTT packet identifier to check.</param>
public bool IsPending(ushort packetId) => _pending.ContainsKey(packetId);
/// <summary>Clears all pending messages.</summary>
@@ -90,10 +95,15 @@ public sealed class MqttQoS1Tracker
/// </summary>
public sealed class QoS1PendingMessage
{
/// <summary>MQTT packet identifier assigned to this outbound QoS1 message.</summary>
public ushort PacketId { get; init; }
/// <summary>MQTT topic associated with the message.</summary>
public string Topic { get; init; } = string.Empty;
/// <summary>Outbound payload bytes awaiting PUBACK.</summary>
public byte[] Payload { get; init; } = [];
/// <summary>UTC timestamp when this message was last sent.</summary>
public DateTime SentAtUtc { get; set; }
/// <summary>Number of delivery attempts for this packet.</summary>
public int DeliveryCount { get; set; } = 1;
/// <summary>