Merge pull request #66 from JTrotta/develop

Add support to not persistent Queue

MQTTnet.Core/Client/IMqttClient.cs

@@ -13,7 +13,7 @@ namespace MQTTnet.Core.Client
         event EventHandler Connected;
         event EventHandler Disconnected;
 
-        Task ConnectAsync(MqttClientOptions options);
+        Task ConnectAsync(IMqttClientOptions options);
         Task DisconnectAsync();
 
         Task<IList<MqttSubscribeResult>> SubscribeAsync(IEnumerable<TopicFilter> topicFilters);

MQTTnet.Core/Client/IMqttClientFactory.cs

@@ -3,5 +3,7 @@
     public interface IMqttClientFactory
     {
         IMqttClient CreateMqttClient();
+
+        IMqttClientManaged CreateMqttManagedClient();
     }
 }

MQTTnet.Core/Client/IMqttClientManaged.cs

@@ -0,0 +1,9 @@
+using System.Threading.Tasks;
+
+namespace MQTTnet.Core.Client
+{
+    public interface IMqttClientManaged : IMqttClient
+    {
+        //Task ConnectAsync(MqttClientManagedOptions options);
+    }
+}

MQTTnet.Core/Client/IMqttClientQueuedStorage.cs

@@ -0,0 +1,12 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace MQTTnet.Core.Client
+{
+    public interface IMqttClientQueuedStorage
+    {
+        Task SaveQueuedMessagesAsync(IList<MqttApplicationMessage> messages);
+
+        Task<IList<MqttApplicationMessage>> LoadQueuedMessagesAsync();
+    }
+}

MQTTnet.Core/Client/IMqttCommunicationAdapterFactory.cs

@@ -4,6 +4,6 @@ namespace MQTTnet.Core.Client
 {
     public interface IMqttCommunicationAdapterFactory
     {
-        IMqttCommunicationAdapter CreateMqttCommunicationAdapter(MqttClientOptions options);
+        IMqttCommunicationAdapter CreateMqttCommunicationAdapter(IMqttClientOptions options);
     }
 }

MQTTnet.Core/Client/MqttClient.cs

@@ -18,11 +18,11 @@ namespace MQTTnet.Core.Client
         private readonly MqttPacketDispatcher _packetDispatcher = new MqttPacketDispatcher();
         private readonly IMqttCommunicationAdapterFactory _communicationChannelFactory;
 
-        private MqttClientOptions _options;
+        private IMqttClientOptions _options;
         private bool _isReceivingPackets;
         private int _latestPacketIdentifier;
-        private CancellationTokenSource _cancellationTokenSource;
-        private IMqttCommunicationAdapter _adapter;
+        internal CancellationTokenSource _cancellationTokenSource;
+        internal IMqttCommunicationAdapter _adapter;
 
         public MqttClient(IMqttCommunicationAdapterFactory communicationChannelFactory)
         {
@@ -35,7 +35,8 @@ namespace MQTTnet.Core.Client
 
         public bool IsConnected => _cancellationTokenSource != null && !_cancellationTokenSource.IsCancellationRequested;
 
-        public async Task ConnectAsync(MqttClientOptions options)
+
+        public async Task ConnectAsync(IMqttClientOptions options)
         {
             if (options == null) throw new ArgumentNullException(nameof(options));
 
@@ -344,7 +345,7 @@ namespace MQTTnet.Core.Client
             return _adapter.SendPacketsAsync(_options.DefaultCommunicationTimeout, _cancellationTokenSource.Token, packet);
         }
 
-        private async Task<TResponsePacket> SendAndReceiveAsync<TResponsePacket>(MqttBasePacket requestPacket) where TResponsePacket : MqttBasePacket
+        internal async Task<TResponsePacket> SendAndReceiveAsync<TResponsePacket>(MqttBasePacket requestPacket) where TResponsePacket : MqttBasePacket
         {
             var packetAwaiter = _packetDispatcher.WaitForPacketAsync(requestPacket, typeof(TResponsePacket), _options.DefaultCommunicationTimeout);
             await _adapter.SendPacketsAsync(_options.DefaultCommunicationTimeout, _cancellationTokenSource.Token, requestPacket).ConfigureAwait(false);

MQTTnet.Core/Client/MqttClientManaged .cs

@@ -0,0 +1,163 @@
+using System;
+using System.Collections.Concurrent;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using MQTTnet.Core.Adapter;
+using MQTTnet.Core.Diagnostics;
+using MQTTnet.Core.Exceptions;
+using MQTTnet.Core.Packets;
+using MQTTnet.Core.Protocol;
+using MQTTnet.Core.Internal;
+
+namespace MQTTnet.Core.Client
+{
+    public class MqttClientManaged: IMqttClientManaged
+    {
+        private MqttClientManagedOptions _options;
+        private int _latestPacketIdentifier;
+        private readonly BlockingCollection<MqttApplicationMessage> _inflightQueue;
+        private bool _usePersistance = false;
+        private MqttClientQueuedPersistentMessagesManager _persistentMessagesManager;
+        private readonly MqttClient _baseMqttClient;
+
+        public MqttClientManaged(IMqttCommunicationAdapterFactory communicationChannelFactory)
+        {
+            _baseMqttClient = new MqttClient(communicationChannelFactory);
+            _baseMqttClient.Connected += BaseMqttClient_Connected;
+            _baseMqttClient.Disconnected += BaseMqttClient_Disconnected;
+            _baseMqttClient.ApplicationMessageReceived += BaseMqttClient_ApplicationMessageReceived;
+            _inflightQueue = new BlockingCollection<MqttApplicationMessage>();
+        }
+
+        private void BaseMqttClient_ApplicationMessageReceived(object sender, MqttApplicationMessageReceivedEventArgs e)
+        {
+            ApplicationMessageReceived?.Invoke(this, e);
+        }
+
+        private void BaseMqttClient_Disconnected(object sender, EventArgs e)
+        {
+            Disconnected?.Invoke(this, e);
+        }
+
+        private void BaseMqttClient_Connected(object sender, EventArgs e)
+        {
+            Connected?.Invoke(this, e);
+        }
+
+        public event EventHandler Connected;
+        public event EventHandler Disconnected;
+        public event EventHandler<MqttApplicationMessageReceivedEventArgs> ApplicationMessageReceived;
+
+        public bool IsConnected => _baseMqttClient.IsConnected;
+
+
+        public async Task ConnectAsync(IMqttClientOptions options)
+        {
+            //TODO VERY BAD
+            _options = options as MqttClientManagedOptions;
+            this._usePersistance = _options.Storage != null;
+            await _baseMqttClient.ConnectAsync(options);
+            SetupOutgoingPacketProcessingAsync();
+
+            //load persistentMessages
+            if (_usePersistance)
+            {
+                if (_persistentMessagesManager == null)
+                    _persistentMessagesManager = new MqttClientQueuedPersistentMessagesManager(_options);
+                await _persistentMessagesManager.LoadMessagesAsync();
+                await InternalPublishAsync(_persistentMessagesManager.GetMessages(), false);
+            }
+        }
+
+        public async Task DisconnectAsync()
+        {
+            await _baseMqttClient.DisconnectAsync();
+        }
+
+        public async Task UnsubscribeAsync(IEnumerable<string> topicFilters)
+        {
+            await _baseMqttClient.UnsubscribeAsync(topicFilters);
+        }
+
+        public async Task PublishAsync(IEnumerable<MqttApplicationMessage> applicationMessages)
+        {
+            await InternalPublishAsync(applicationMessages, true);
+        }
+
+        private async Task InternalPublishAsync(IEnumerable<MqttApplicationMessage> applicationMessages, bool appendIfUsePersistance)
+        {
+            ThrowIfNotConnected();
+
+            foreach (var applicationMessage in applicationMessages)
+            {
+                if (_usePersistance && appendIfUsePersistance)
+                    await _persistentMessagesManager.SaveMessageAsync(applicationMessage);
+
+                _inflightQueue.Add(applicationMessage);
+            }
+        }
+
+        public async Task<IList<MqttSubscribeResult>> SubscribeAsync(IEnumerable<TopicFilter> topicFilters)
+        {
+            return await _baseMqttClient.SubscribeAsync(topicFilters);
+        }
+
+        private void ThrowIfNotConnected()
+        {
+            if (!IsConnected) throw new MqttCommunicationException("The client is not connected.");
+        }
+
+        private ushort GetNewPacketIdentifier()
+        {
+            return (ushort)Interlocked.Increment(ref _latestPacketIdentifier);
+        }
+        
+
+        private void SetupOutgoingPacketProcessingAsync()
+        {
+            Task.Factory.StartNew(
+                () => SendPackets(_baseMqttClient._cancellationTokenSource.Token),
+                _baseMqttClient._cancellationTokenSource.Token,
+                TaskCreationOptions.LongRunning,
+                TaskScheduler.Default).ConfigureAwait(false);
+        }
+
+        private async Task SendPackets(CancellationToken cancellationToken)
+        {
+            MqttNetTrace.Information(nameof(MqttClientManaged), "Start sending packets.");
+            MqttApplicationMessage messageInQueue = null;
+
+            try
+            {
+                while (!cancellationToken.IsCancellationRequested)
+                {
+                    messageInQueue = _inflightQueue.Take();
+                    await _baseMqttClient.PublishAsync(new List<MqttApplicationMessage>() { messageInQueue });
+                    if (_usePersistance)
+                        await _persistentMessagesManager.Remove(messageInQueue);                   
+                }
+            }
+            catch (OperationCanceledException)
+            {
+            }
+            catch (MqttCommunicationException exception)
+            {
+                MqttNetTrace.Warning(nameof(MqttClient), exception, "MQTT communication exception while sending packets.");
+                //message not send, equeue it again
+                if (messageInQueue != null)
+                    _inflightQueue.Add(messageInQueue);
+            }
+            catch (Exception exception)
+            {
+                MqttNetTrace.Error(nameof(MqttClient), exception, "Unhandled exception while sending packets.");
+                await DisconnectAsync().ConfigureAwait(false);
+            }
+            finally
+            {
+                MqttNetTrace.Information(nameof(MqttClient), "Stopped sending packets.");
+            }
+        }
+    }
+}

MQTTnet.Core/Client/MqttClientManagedOptions.cs

@@ -0,0 +1,12 @@
+
+using System;
+
+namespace MQTTnet.Core.Client
+{
+    public class MqttClientManagedOptions: MqttClientTcpOptions
+    {
+        public bool UseAutoReconnect { get; set; }
+        public TimeSpan AutoReconnectDelay { get; set; }
+        public IMqttClientQueuedStorage Storage { get; set; }
+    }
+}

MQTTnet.Core/Client/MqttClientOptions.cs

@@ -1,26 +1,26 @@
-using System;
-using MQTTnet.Core.Serializer;
+using MQTTnet.Core.Serializer;
+using System;
 
 namespace MQTTnet.Core.Client
 {
-    public abstract class MqttClientOptions
+    public interface IMqttClientOptions
     {
-        public MqttClientTlsOptions TlsOptions { get; set; } = new MqttClientTlsOptions();
+        MqttClientTlsOptions TlsOptions { get; set; }
 
-        public MqttApplicationMessage WillMessage { get; set; }
+        MqttApplicationMessage WillMessage { get; set; }
 
-        public string UserName { get; set; }
+        string UserName { get; set; }
 
-        public string Password { get; set; }
+        string Password { get; set; }
 
-        public string ClientId { get; set; } = Guid.NewGuid().ToString().Replace("-", string.Empty);
+        string ClientId { get; set; }
 
-        public bool CleanSession { get; set; } = true;
+        bool CleanSession { get; set; }
 
-        public TimeSpan KeepAlivePeriod { get; set; } = TimeSpan.FromSeconds(5);
+        TimeSpan KeepAlivePeriod { get; set; }
 
-        public TimeSpan DefaultCommunicationTimeout { get; set; } = TimeSpan.FromSeconds(10);
+        TimeSpan DefaultCommunicationTimeout { get; set; }
 
-        public MqttProtocolVersion ProtocolVersion { get; set; } = MqttProtocolVersion.V311;
+        MqttProtocolVersion ProtocolVersion { get; set; }
     }
 }

MQTTnet.Core/Client/MqttClientQueuedPersistentMessagesManager.cs

@@ -0,0 +1,84 @@
+using MQTTnet.Core.Diagnostics;
+using MQTTnet.Core.Packets;
+using System;
+using System.Linq;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace MQTTnet.Core.Client
+{
+    public class MqttClientQueuedPersistentMessagesManager
+    {
+        private readonly IList<MqttApplicationMessage> _persistedMessages = new List<MqttApplicationMessage>();
+        private readonly MqttClientManagedOptions _options;
+
+        public MqttClientQueuedPersistentMessagesManager(MqttClientManagedOptions options)
+        {
+            _options = options ?? throw new ArgumentNullException(nameof(options));
+        }
+
+        public async Task LoadMessagesAsync()
+        {
+            try
+            {
+                var persistentMessages = await _options.Storage.LoadQueuedMessagesAsync();
+                lock (_persistedMessages)
+                {
+                    _persistedMessages.Clear();
+                    foreach (var persistentMessage in persistentMessages)
+                    {
+                        _persistedMessages.Add(persistentMessage);
+                    }
+                }
+            }
+            catch (Exception exception)
+            {
+                MqttNetTrace.Error(nameof(MqttClientQueuedPersistentMessagesManager), exception, "Unhandled exception while loading persistent messages.");
+            }
+        }
+
+        public async Task SaveMessageAsync(MqttApplicationMessage applicationMessage)
+        {
+            if (applicationMessage != null)
+            {
+                lock (_persistedMessages)
+                {
+                    _persistedMessages.Add(applicationMessage);
+                }
+            }
+            try
+            {               
+                if (_options.Storage != null)
+                {
+                    await _options.Storage.SaveQueuedMessagesAsync(_persistedMessages);
+                }
+            }
+            catch (Exception exception)
+            {
+                MqttNetTrace.Error(nameof(MqttClientQueuedPersistentMessagesManager), exception, "Unhandled exception while saving persistent messages.");
+            }
+        }
+
+        public List<MqttApplicationMessage> GetMessages()
+        {
+            var persistedMessages = new List<MqttApplicationMessage>();
+            lock (_persistedMessages)
+            {
+                foreach (var persistedMessage in _persistedMessages)
+                {
+                    persistedMessages.Add(persistedMessage);
+                }
+            }
+
+            return persistedMessages;
+        }
+
+        public async Task Remove(MqttApplicationMessage message)
+        {
+            lock (_persistedMessages)
+                _persistedMessages.Remove(message);
+
+            await SaveMessageAsync(null);
+        }
+    }
+}

MQTTnet.Core/Client/MqttClientTcpOptions.cs

@@ -1,7 +1,29 @@
-namespace MQTTnet.Core.Client
+using MQTTnet.Core.Serializer;
+using System;
+
+namespace MQTTnet.Core.Client
 {
-    public class MqttClientTcpOptions : MqttClientOptions
+    public class MqttClientTcpOptions : IMqttClientOptions
     {
+        public MqttClientTlsOptions TlsOptions { get; set; } = new MqttClientTlsOptions();
+
+        public MqttApplicationMessage WillMessage { get; set; }
+
+        public string UserName { get; set; }
+
+        public string Password { get; set; }
+
+        public string ClientId { get; set; } = Guid.NewGuid().ToString().Replace("-", string.Empty);
+
+        public bool CleanSession { get; set; } = true;
+
+        public TimeSpan KeepAlivePeriod { get; set; } = TimeSpan.FromSeconds(5);
+
+        public TimeSpan DefaultCommunicationTimeout { get; set; } = TimeSpan.FromSeconds(10);
+
+        public MqttProtocolVersion ProtocolVersion { get; set; } = MqttProtocolVersion.V311;
+
+
         public string Server { get; set; }
 
         public int? Port { get; set; }

MQTTnet.Core/Client/MqttClientWebSocketOptions.cs

@@ -1,7 +1,29 @@
-namespace MQTTnet.Core.Client
+using System;
+using MQTTnet.Core.Serializer;
+
+namespace MQTTnet.Core.Client
 {
-    public class MqttClientWebSocketOptions : MqttClientOptions
+    public class MqttClientWebSocketOptions : IMqttClientOptions
     {
         public string Uri { get; set; }
+
+        public MqttClientTlsOptions TlsOptions { get; set; } = new MqttClientTlsOptions();
+
+        public MqttApplicationMessage WillMessage { get; set; }
+
+        public string UserName { get; set; }
+
+        public string Password { get; set; }
+
+        public string ClientId { get; set; } = Guid.NewGuid().ToString().Replace("-", string.Empty);
+
+        public bool CleanSession { get; set; } = true;
+
+        public TimeSpan KeepAlivePeriod { get; set; } = TimeSpan.FromSeconds(5);
+
+        public TimeSpan DefaultCommunicationTimeout { get; set; } = TimeSpan.FromSeconds(10);
+
+        public MqttProtocolVersion ProtocolVersion { get; set; } = MqttProtocolVersion.V311;
+
     }
 }

MQTTnet.Core/MQTTnet.Core.csproj

@@ -22,14 +22,6 @@
     <PackageLicenseUrl></PackageLicenseUrl>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Any CPU|AnyCPU'" />
 
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Any CPU|x64'" />
-
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|x86'" />
-
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|x86'" />
-
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Any CPU|x86'" />
 
 </Project>