Merge branch 'develop'

dotnet · May 11, 2019 · ac88f0a · ac88f0a
2 parents 914d2b6 + b02f308
commit ac88f0a
Show file tree

Hide file tree

Showing 10 changed files with 89 additions and 68 deletions.
diff --git a/Build/MQTTnet.Extensions.ManagedClient.nuspec b/Build/MQTTnet.Extensions.ManagedClient.nuspec
@@ -34,10 +34,9 @@
     <!-- .NET Framework -->
     <file src="..\Source\MQTTnet.Extensions.ManagedClient\bin\Release\net452\MQTTnet.Extensions.ManagedClient.*" target="lib\net452\"/>
 
-    <file src="..\Source\MQTTnet.Extensions.ManagedClient\bin\Release\netstandard2.0\MQTTnet.Extensions.ManagedClient.*" target="lib\net461\"/>
-    <file src="..\Source\MQTTnet.Extensions.ManagedClient\bin\Release\netstandard2.0\MQTTnet.Extensions.ManagedClient.*" target="lib\net462\"/>
-    <file src="..\Source\MQTTnet.Extensions.ManagedClient\bin\Release\netstandard2.0\MQTTnet.Extensions.ManagedClient.*" target="lib\net470\"/>
-    <file src="..\Source\MQTTnet.Extensions.ManagedClient\bin\Release\netstandard2.0\MQTTnet.Extensions.ManagedClient.*" target="lib\net471\"/>
-    <file src="..\Source\MQTTnet.Extensions.ManagedClient\bin\Release\netstandard2.0\MQTTnet.Extensions.ManagedClient.*" target="lib\net472\"/>
+    <!-- .NET Framework 4.6.0 will use binaries from 4.5.2. -->
+    <file src="..\Source\MQTTnet.Extensions.ManagedClient\bin\Release\net461\MQTTnet.Extensions.Rpc.*" target="lib\net461\"/>
+
+    <!-- Everything above .NET Framework 4.6.1 will use the binaries from 4.6.1. -->
   </files>
 </package>
diff --git a/Build/MQTTnet.Extensions.Rpc.nuspec b/Build/MQTTnet.Extensions.Rpc.nuspec
@@ -34,10 +34,9 @@
     <!-- .NET Framework -->
     <file src="..\Source\MQTTnet.Extensions.Rpc\bin\Release\net452\MQTTnet.Extensions.Rpc.*" target="lib\net452\"/>
 
-    <file src="..\Source\MQTTnet.Extensions.Rpc\bin\Release\netstandard2.0\MQTTnet.Extensions.Rpc.*" target="lib\net461\"/>
-    <file src="..\Source\MQTTnet.Extensions.Rpc\bin\Release\netstandard2.0\MQTTnet.Extensions.Rpc.*" target="lib\net462\"/>
-    <file src="..\Source\MQTTnet.Extensions.Rpc\bin\Release\netstandard2.0\MQTTnet.Extensions.Rpc.*" target="lib\net470\"/>
-    <file src="..\Source\MQTTnet.Extensions.Rpc\bin\Release\netstandard2.0\MQTTnet.Extensions.Rpc.*" target="lib\net471\"/>
-    <file src="..\Source\MQTTnet.Extensions.Rpc\bin\Release\netstandard2.0\MQTTnet.Extensions.Rpc.*" target="lib\net472\"/>
+    <!-- .NET Framework 4.6.0 will use binaries from 4.5.2. -->
+    <file src="..\Source\MQTTnet.Extensions.Rpc\bin\Release\net461\MQTTnet.Extensions.Rpc.*" target="lib\net461\"/>
+
+    <!-- Everything above .NET Framework 4.6.1 will use the binaries from 4.6.1. -->
   </files>
 </package>
diff --git a/Build/MQTTnet.nuspec b/Build/MQTTnet.nuspec
@@ -11,36 +11,12 @@
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>MQTTnet is a high performance .NET library for MQTT based communication. It provides a MQTT client and a MQTT server (broker).</description>
     <releaseNotes>
-* [Core] Added support for MQTTv5 packages.
-* [Core] Performance improvements.
-* [Core] Removed obsolete methods.
-* [Core] Fixed a memory leak when processing lots of messages (thanks to @tschanko)
-* [Core] Added more overloads for MQTT factory.
-* [Core] The client password is now hidden from the logs (replaced with **** if set).
-* [Core] Fixed a memory leak when using SSL connections (thanks to @biovoid). 
-* [Client] Added validation of topics before publishing.
-* [Client] Added new MQTTv5 features to options builder.
-* [Client] Added uniform API across all supported MQTT versions (BREAKING CHANGE!)
-* [Client] The client will now avoid sending an ACK if an exception has been thrown in message handler (thanks to @ramonsmits).
-* [Client] Fixed issues in QoS 2 handling which leads to message loss.
-* [Client] Replaced all events with proper async compatible handlers (BREAKING CHANGE!).
-* [Client] Added more configuration values to TCP endpoint options.
-* [Client] Added used PacketIdentifier to publish result.
-* [ManagedClient] Replaced all events with proper async compatible handlers (BREAKING CHANGE!).
-* [ManagedClient] The log ID is now propagated to the internal client (thanks to @vbBerni).
-* [ManagedClient] Added validation of topics before publishing.
-* [ManagedClient] The internal MQTT client is now closed properly (thanks to @vbBerni).
-* [Server] Added support for MQTTv5 clients. The server will still return _success_ for all cases at the moment even if more granular codes are available.
-* [Server] Fixed issues in QoS 2 handling which leads to message loss.
-* [Server] Replaced all events with proper async compatible handlers (BREAKING CHANGE!).
-* [Server] The used logger instance is now propagated to the WebSocket server adapter.
-* [Server] Added the flag "IsSecureConnection" which is set to true when the connection is encrypted.
-* [Server] Fixed wrong will message behavior when stopping server (thanks to @JohBa)
-* [Server] Added validation of topics before publishing.
-* [Server] Added more configuration values to TCP endpoint options.
-* [MQTTnet Server] Added as first Alpha version of standalone cross platform MQTT server.
-
-* [Note] Due to MQTTv5 a lot of new classes were introduced. This required adding new namespaces as well. Most classes are backward compatible but new namespaces must be added.
+* [Core] Fixed missing properties from PUBLISH packet in _MqttApplicationMessage_ (thanks to @pcbing).
+* [Core] Fixed wrong encoding of PUBREL and PUBCOMP packets for MQTTv5 (thanks to @perphilipp).
+* [Client] Added the authentication result to the disconnected handler (only set when connecting failed).
+* [Client] Added new overloads for _MqttClientOptionsBuilder_.
+* [Server] Fixed a bug which returns wrong flag for existing session in CONNACK packet (thanks to @avengerstark).
+* [nuget] .NET Framework builds are now using 4.5.2 or 4.6.1 builds instead of netstandard 2.0.
     </releaseNotes>
     <copyright>Copyright Christian Kratky 2016-2019</copyright>
     <tags>MQTT Message Queue Telemetry Transport MQTTClient MQTTServer Server MQTTBroker Broker NETStandard IoT InternetOfThings Messaging Hardware Arduino Sensor Actuator M2M ESP Smart Home Cities Automation Xamarin</tags> 
@@ -60,10 +36,6 @@
       <group targetFramework="uap10.0">
         <dependency id="Microsoft.NETCore.UniversalWindowsPlatform" version="6.2.8" />
       </group>
-      <group targetFramework="net452">
-      </group>
-      <group targetFramework="net461">
-      </group>
     </dependencies>
   </metadata>
 
@@ -83,10 +55,9 @@
     <!-- .NET Framework -->
     <file src="..\Source\MQTTnet\bin\Release\net452\MQTTnet.*" target="lib\net452\"/>
 
-    <file src="..\Source\MQTTnet\bin\Release\netstandard2.0\MQTTnet.*" target="lib\net461\"/>
-    <file src="..\Source\MQTTnet\bin\Release\netstandard2.0\MQTTnet.*" target="lib\net462\"/>
-    <file src="..\Source\MQTTnet\bin\Release\netstandard2.0\MQTTnet.*" target="lib\net470\"/>
-    <file src="..\Source\MQTTnet\bin\Release\netstandard2.0\MQTTnet.*" target="lib\net471\"/>
-    <file src="..\Source\MQTTnet\bin\Release\netstandard2.0\MQTTnet.*" target="lib\net472\"/>
+    <!-- .NET Framework 4.6.0 will use binaries from 4.5.2. -->
+    <file src="..\Source\MQTTnet\bin\Release\net461\MQTTnet.*" target="lib\net461\"/>
+
+    <!-- Everything above .NET Framework 4.6.1 will use the binaries from 4.6.1. -->
   </files>
 </package>
diff --git a/Source/MQTTnet/Client/Disconnecting/MqttClientDisconnectedEventArgs.cs b/Source/MQTTnet/Client/Disconnecting/MqttClientDisconnectedEventArgs.cs
@@ -1,17 +1,21 @@
 using System;
+using MQTTnet.Client.Connecting;
 
 namespace MQTTnet.Client.Disconnecting
 {
     public class MqttClientDisconnectedEventArgs : EventArgs
     {
-        public MqttClientDisconnectedEventArgs(bool clientWasConnected, Exception exception)
+        public MqttClientDisconnectedEventArgs(bool clientWasConnected, Exception exception, MqttClientAuthenticateResult authenticateResult)
         {
             ClientWasConnected = clientWasConnected;
             Exception = exception;
+            AuthenticateResult = authenticateResult;
         }
 
         public bool ClientWasConnected { get; }
 
         public Exception Exception { get; }
+
+        public MqttClientAuthenticateResult AuthenticateResult { get; }
     }
 }
diff --git a/Source/MQTTnet/Client/MqttClient.cs b/Source/MQTTnet/Client/MqttClient.cs
@@ -61,6 +61,8 @@ public async Task<MqttClientAuthenticateResult> ConnectAsync(IMqttClientOptions
 
             ThrowIfConnected("It is not allowed to connect with a server after the connection is established.");
 
+            MqttClientAuthenticateResult authenticateResult = null;
+
             try
             {
                 Options = options;
@@ -81,7 +83,7 @@ public async Task<MqttClientAuthenticateResult> ConnectAsync(IMqttClientOptions
 
                 _packetReceiverTask = Task.Run(() => TryReceivePacketsAsync(backgroundCancellationToken), backgroundCancellationToken);
 
-                var authenticateResult = await AuthenticateAsync(adapter, options.WillMessage, cancellationToken).ConfigureAwait(false);
+                authenticateResult = await AuthenticateAsync(adapter, options.WillMessage, cancellationToken).ConfigureAwait(false);
 
                 _sendTracker.Restart();
 
@@ -108,7 +110,7 @@ public async Task<MqttClientAuthenticateResult> ConnectAsync(IMqttClientOptions
 
                 if (!DisconnectIsPending())
                 {
-                    await DisconnectInternalAsync(null, exception).ConfigureAwait(false);
+                    await DisconnectInternalAsync(null, exception, authenticateResult).ConfigureAwait(false);
                 }
 
                 throw;
@@ -131,7 +133,7 @@ public async Task DisconnectAsync(MqttClientDisconnectOptions options, Cancellat
             {
                 if (!DisconnectIsPending())
                 {
-                    await DisconnectInternalAsync(null, null).ConfigureAwait(false);
+                    await DisconnectInternalAsync(null, null, null).ConfigureAwait(false);
                 }
             }
         }
@@ -232,7 +234,7 @@ private void ThrowIfConnected(string message)
             if (IsConnected) throw new MqttProtocolViolationException(message);
         }
 
-        private async Task DisconnectInternalAsync(Task sender, Exception exception)
+        private async Task DisconnectInternalAsync(Task sender, Exception exception, MqttClientAuthenticateResult authenticateResult)
         {
             var clientWasConnected = IsConnected;
 
@@ -267,7 +269,7 @@ private async Task DisconnectInternalAsync(Task sender, Exception exception)
                 var disconnectedHandler = DisconnectedHandler;
                 if (disconnectedHandler != null)
                 {
-                    await disconnectedHandler.HandleDisconnectedAsync(new MqttClientDisconnectedEventArgs(clientWasConnected, exception)).ConfigureAwait(false);
+                    await disconnectedHandler.HandleDisconnectedAsync(new MqttClientDisconnectedEventArgs(clientWasConnected, exception, authenticateResult)).ConfigureAwait(false);
                 }
             }
         }
@@ -376,7 +378,7 @@ private async Task TrySendKeepAliveMessagesAsync(CancellationToken cancellationT
 
                 if (!DisconnectIsPending())
                 {
-                    await DisconnectInternalAsync(_keepAlivePacketsSenderTask, exception).ConfigureAwait(false);
+                    await DisconnectInternalAsync(_keepAlivePacketsSenderTask, exception, null).ConfigureAwait(false);
                 }
             }
             finally
@@ -404,7 +406,7 @@ private async Task TryReceivePacketsAsync(CancellationToken cancellationToken)
                     {
                         if (!DisconnectIsPending())
                         {
-                            await DisconnectInternalAsync(_packetReceiverTask, null).ConfigureAwait(false);
+                            await DisconnectInternalAsync(_packetReceiverTask, null, null).ConfigureAwait(false);
                         }
 
                         return;
@@ -436,7 +438,7 @@ private async Task TryReceivePacketsAsync(CancellationToken cancellationToken)
 
                 if (!DisconnectIsPending())
                 {
-                    await DisconnectInternalAsync(_packetReceiverTask, exception).ConfigureAwait(false);
+                    await DisconnectInternalAsync(_packetReceiverTask, exception, null).ConfigureAwait(false);
                 }
             }
             finally
@@ -497,7 +499,7 @@ await SendAsync(new MqttPubCompPacket
 
                 if (!DisconnectIsPending())
                 {
-                    await DisconnectInternalAsync(_packetReceiverTask, exception).ConfigureAwait(false);
+                    await DisconnectInternalAsync(_packetReceiverTask, exception, null).ConfigureAwait(false);
                 }
             }
         }

diff --git a/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs b/Source/MQTTnet/Client/Options/MqttClientOptionsBuilder.cs
@@ -136,6 +136,16 @@ public MqttClientOptionsBuilder WithTcpServer(string server, int? port = null)
             return this;
         }
 
+        public MqttClientOptionsBuilder WithTcpServer(Action<MqttClientTcpOptions> optionsBuilder)
+        {
+            if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder));
+
+            _tcpOptions = new MqttClientTcpOptions();
+            optionsBuilder.Invoke(_tcpOptions);
+
+            return this;
+        }
+
         public MqttClientOptionsBuilder WithProxy(string address, string username = null, string password = null, string domain = null, bool bypassOnLocal = false, string[] bypassList = null)
         {
             _proxyOptions = new MqttClientWebSocketProxyOptions
@@ -151,6 +161,15 @@ public MqttClientOptionsBuilder WithProxy(string address, string username = null
             return this;
         }
 
+        public MqttClientOptionsBuilder WithProxy(Action<MqttClientWebSocketProxyOptions> optionsBuilder)
+        {
+            if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder));
+
+            _proxyOptions = new MqttClientWebSocketProxyOptions();
+            optionsBuilder(_proxyOptions);
+            return this;
+        }
+
         public MqttClientOptionsBuilder WithWebSocketServer(string uri, MqttClientOptionsBuilderWebSocketParameters parameters = null)
         {
             _webSocketOptions = new MqttClientWebSocketOptions
@@ -163,9 +182,19 @@ public MqttClientOptionsBuilder WithWebSocketServer(string uri, MqttClientOption
             return this;
         }
 
+        public MqttClientOptionsBuilder WithWebSocketServer(Action<MqttClientWebSocketOptions> optionsBuilder)
+        {
+            if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder));
+
+            _webSocketOptions = new MqttClientWebSocketOptions();
+            optionsBuilder.Invoke(_webSocketOptions);
+
+            return this;
+        }
+
         public MqttClientOptionsBuilder WithTls(MqttClientOptionsBuilderTlsParameters parameters)
         {
-            _tlsParameters = parameters ?? throw new ArgumentNullException(nameof(parameters));
+            _tlsParameters = parameters;
             return this;
         }
 
@@ -174,6 +203,15 @@ public MqttClientOptionsBuilder WithTls()
             return WithTls(new MqttClientOptionsBuilderTlsParameters { UseTls = true });
         }
 
+        public MqttClientOptionsBuilder WithTls(Action<MqttClientOptionsBuilderTlsParameters> optionsBuilder)
+        {
+            if (optionsBuilder == null) throw new ArgumentNullException(nameof(optionsBuilder));
+
+            _tlsParameters = new MqttClientOptionsBuilderTlsParameters();
+            optionsBuilder(_tlsParameters);
+            return this;
+        }
+
         public IMqttClientOptions Build()
         {
             if (_tcpOptions == null && _webSocketOptions == null)

diff --git a/Source/MQTTnet/Formatter/V5/MqttV500DataConverter.cs b/Source/MQTTnet/Formatter/V5/MqttV500DataConverter.cs
@@ -63,6 +63,13 @@ public MqttApplicationMessage CreateApplicationMessage(MqttPublishPacket publish
                 Payload = publishPacket.Payload,
                 QualityOfServiceLevel = publishPacket.QualityOfServiceLevel,
                 Retain = publishPacket.Retain,
+                ResponseTopic = publishPacket.Properties?.ResponseTopic,
+                ContentType = publishPacket.Properties?.ContentType,
+                CorrelationData = publishPacket.Properties?.CorrelationData,
+                MessageExpiryInterval = publishPacket.Properties?.MessageExpiryInterval,
+                SubscriptionIdentifier = publishPacket.Properties?.SubscriptionIdentifier,
+                TopicAlias = publishPacket.Properties?.TopicAlias,
+                PayloadFormatIndicator = publishPacket.Properties?.PayloadFormatIndicator,
                 UserProperties = publishPacket.Properties?.UserProperties ?? new List<MqttUserProperty>()
             };
         }

diff --git a/Source/MQTTnet/Formatter/V5/MqttV500PacketEncoder.cs b/Source/MQTTnet/Formatter/V5/MqttV500PacketEncoder.cs
@@ -343,17 +343,16 @@ private static byte EncodePubRelPacket(MqttPubRelPacket packet, IMqttPacketWrite
                 ThrowReasonCodeNotSetException();
             }
 
-            packetWriter.Write(packet.PacketIdentifier.Value);
-            packetWriter.Write((byte)packet.ReasonCode.Value);
-
             var propertiesWriter = new MqttV500PropertiesWriter();
             if (packet.Properties != null)
             {
                 propertiesWriter.WriteReasonString(packet.Properties.ReasonString);
                 propertiesWriter.WriteUserProperties(packet.Properties.UserProperties);
             }
 
-            if (packetWriter.Length > 0 || packet.ReasonCode.Value != MqttPubRelReasonCode.Success)
+            packetWriter.Write(packet.PacketIdentifier.Value);
+
+            if (propertiesWriter.Length > 0 || packet.ReasonCode.Value != MqttPubRelReasonCode.Success)
             {
                 packetWriter.Write((byte)packet.ReasonCode.Value);
                 propertiesWriter.WriteToPacket(packetWriter);
@@ -372,16 +371,15 @@ private static byte EncodePubCompPacket(MqttPubCompPacket packet, IMqttPacketWri
             }
 
             packetWriter.Write(packet.PacketIdentifier.Value);
-            packetWriter.Write((byte)packet.ReasonCode.Value);
-
+
             var propertiesWriter = new MqttV500PropertiesWriter();
             if (packet.Properties != null)
             {
                 propertiesWriter.WriteReasonString(packet.Properties.ReasonString);
                 propertiesWriter.WriteUserProperties(packet.Properties.UserProperties);
             }
 
-            if (packetWriter.Length > 0 || packet.ReasonCode.Value != MqttPubCompReasonCode.Success)
+            if (propertiesWriter.Length > 0 || packet.ReasonCode.Value != MqttPubCompReasonCode.Success)
             {
                 packetWriter.Write((byte)packet.ReasonCode.Value);
                 propertiesWriter.WriteToPacket(packetWriter);

diff --git a/Source/MQTTnet/Formatter/V5/MqttV500PropertiesWriter.cs b/Source/MQTTnet/Formatter/V5/MqttV500PropertiesWriter.cs
@@ -7,8 +7,11 @@ namespace MQTTnet.Formatter.V5
 {
     public class MqttV500PropertiesWriter
     {
+        // TODO: Consider lazy init on first write to avoid useless allocations.
         private readonly MqttPacketWriter _packetWriter = new MqttPacketWriter();
 
+        public int Length => _packetWriter.Length;
+
         public void WriteUserProperties(List<MqttUserProperty> userProperties)
         {
             if (userProperties == null || userProperties.Count == 0)

diff --git a/Source/MQTTnet/Server/MqttClientConnection.cs b/Source/MQTTnet/Server/MqttClientConnection.cs
@@ -138,7 +138,7 @@ await SendAsync(
                     {
                         ReturnCode = MqttConnectReturnCode.ConnectionAccepted,
                         ReasonCode = MqttConnectReasonCode.Success,
-                        IsSessionPresent = Session.IsCleanSession
+                        IsSessionPresent = !Session.IsCleanSession
                     }).ConfigureAwait(false);
 
                 Session.IsCleanSession = false;