v4.0.0 (#1357)

Source/MQTTnet/Client/Publishing/MqttClientPublishReasonCode.cs

@@ -1,8 +1,13 @@
-namespace MQTTnet.Client.Publishing
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+namespace MQTTnet.Client
 {
     public enum MqttClientPublishReasonCode
     {
         Success = 0,
+        
         NoMatchingSubscribers = 16,
         UnspecifiedError = 128,
         ImplementationSpecificError = 131,

Source/MQTTnet/Client/Publishing/MqttClientPublishResult.cs

@@ -1,11 +1,17 @@
-
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
 using System.Collections.Generic;
 using MQTTnet.Packets;
 
-namespace MQTTnet.Client.Publishing
+namespace MQTTnet.Client
 {
-    public class MqttClientPublishResult
+    public sealed class MqttClientPublishResult
     {
+        /// <summary>
+        /// Gets the packet identifier which was used for this publish.
+        /// </summary>
         public ushort? PacketIdentifier { get; set; }
 
         /// <summary>
@@ -27,6 +33,6 @@ namespace MQTTnet.Client.Publishing
         /// The feature is very similar to the HTTP header concept.
         /// Hint: MQTT 5 feature only.
         /// </summary>
-        public List<MqttUserProperty> UserProperties { get; set; }
+        public IReadOnlyCollection<MqttUserProperty> UserProperties { get; internal set; }
     }
 }

Source/MQTTnet/Client/Publishing/MqttClientPublishResultFactory.cs

@@ -0,0 +1,79 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Collections.Generic;
+using MQTTnet.Packets;
+using MQTTnet.Protocol;
+
+namespace MQTTnet.Client
+{
+    public sealed class MqttClientPublishResultFactory
+    {
+        static readonly MqttClientPublishResult EmptySuccessResult = new MqttClientPublishResult();
+        static readonly IReadOnlyCollection<MqttUserProperty> EmptyUserProperties = new List<MqttUserProperty>();
+
+        public MqttClientPublishResult Create(MqttPubAckPacket pubAckPacket)
+        {
+            // QoS 0 has no response. So we treat it as a success always.
+            if (pubAckPacket == null)
+            {
+                return EmptySuccessResult;
+            }
+
+            var result = new MqttClientPublishResult
+            {
+                // Both enums have the same values. So it can be easily converted.
+                ReasonCode = (MqttClientPublishReasonCode)(int)pubAckPacket.ReasonCode,
+                PacketIdentifier = pubAckPacket.PacketIdentifier,
+                ReasonString = pubAckPacket.ReasonString,
+                UserProperties = pubAckPacket.UserProperties ?? EmptyUserProperties
+            };
+
+            return result;
+        }
+
+        public MqttClientPublishResult Create(MqttPubRecPacket pubRecPacket, MqttPubCompPacket pubCompPacket)
+        {
+            if (pubRecPacket == null || pubCompPacket == null)
+            {
+                return new MqttClientPublishResult
+                {
+                    ReasonCode = MqttClientPublishReasonCode.UnspecifiedError
+                };
+            }
+
+            MqttClientPublishResult result;
+
+            // The PUBCOMP is the last packet in QoS 2. So we use the results from that instead of PUBREC.
+            if (pubCompPacket.ReasonCode == MqttPubCompReasonCode.PacketIdentifierNotFound)
+            {
+                result = new MqttClientPublishResult
+                {
+                    PacketIdentifier = pubCompPacket.PacketIdentifier,
+                    ReasonCode = MqttClientPublishReasonCode.UnspecifiedError,
+                    ReasonString = pubCompPacket.ReasonString,
+                    UserProperties = pubCompPacket.UserProperties ?? EmptyUserProperties
+                };
+
+                return result;
+            }
+
+            result = new MqttClientPublishResult
+            {
+                PacketIdentifier = pubCompPacket.PacketIdentifier,
+                ReasonCode = MqttClientPublishReasonCode.Success,
+                ReasonString = pubCompPacket.ReasonString,
+                UserProperties = pubCompPacket.UserProperties ?? EmptyUserProperties
+            };
+
+            if (pubRecPacket.ReasonCode != MqttPubRecReasonCode.Success)
+            {
+                // Both enums share the same values.
+                result.ReasonCode = (MqttClientPublishReasonCode)pubRecPacket.ReasonCode;
+            }
+
+            return result;
+        }
+    }
+}