Refactor topic filter naming.

Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptions.cs

@@ -5,7 +5,7 @@ namespace MQTTnet.Client.Subscribing
 {
     public class MqttClientSubscribeOptions
     {
-        public List<TopicFilter> TopicFilters { get; set; } = new List<TopicFilter>();
+        public List<MqttTopicFilter> TopicFilters { get; set; } = new List<MqttTopicFilter>();
 
         public uint? SubscriptionIdentifier { get; set; }
 

Source/MQTTnet/Client/Subscribing/MqttClientSubscribeOptionsBuilder.cs

@@ -1,7 +1,7 @@
-using System;
-using System.Collections.Generic;
-using MQTTnet.Packets;
+using MQTTnet.Packets;
 using MQTTnet.Protocol;
+using System;
+using System.Collections.Generic;
 
 namespace MQTTnet.Client.Subscribing
 {
@@ -38,7 +38,7 @@ namespace MQTTnet.Client.Subscribing
             bool? retainAsPublished = null,
             MqttRetainHandling? retainHandling = null)
         {
-            return WithTopicFilter(new TopicFilter
+            return WithTopicFilter(new MqttTopicFilter
             {
                 Topic = topic,
                 QualityOfServiceLevel = qualityOfServiceLevel,
@@ -48,30 +48,30 @@ namespace MQTTnet.Client.Subscribing
             });
         }
 
-        public MqttClientSubscribeOptionsBuilder WithTopicFilter(Action<TopicFilterBuilder> topicFilterBuilder)
+        public MqttClientSubscribeOptionsBuilder WithTopicFilter(Action<MqttTopicFilterBuilder> topicFilterBuilder)
         {
             if (topicFilterBuilder == null) throw new ArgumentNullException(nameof(topicFilterBuilder));
 
-            var internalTopicFilterBuilder = new TopicFilterBuilder();
+            var internalTopicFilterBuilder = new MqttTopicFilterBuilder();
             topicFilterBuilder(internalTopicFilterBuilder);
 
             return WithTopicFilter(internalTopicFilterBuilder);
         }
 
-        public MqttClientSubscribeOptionsBuilder WithTopicFilter(TopicFilterBuilder topicFilterBuilder)
+        public MqttClientSubscribeOptionsBuilder WithTopicFilter(MqttTopicFilterBuilder topicFilterBuilder)
         {
             if (topicFilterBuilder == null) throw new ArgumentNullException(nameof(topicFilterBuilder));
 
             return WithTopicFilter(topicFilterBuilder.Build());
         }
 
-        public MqttClientSubscribeOptionsBuilder WithTopicFilter(TopicFilter topicFilter)
+        public MqttClientSubscribeOptionsBuilder WithTopicFilter(MqttTopicFilter topicFilter)
         {
             if (topicFilter == null) throw new ArgumentNullException(nameof(topicFilter));
 
             if (_subscribeOptions.TopicFilters == null)
             {
-                _subscribeOptions.TopicFilters = new List<TopicFilter>();
+                _subscribeOptions.TopicFilters = new List<MqttTopicFilter>();
             }
 
             _subscribeOptions.TopicFilters.Add(topicFilter);

Source/MQTTnet/Client/Subscribing/MqttClientSubscribeResultItem.cs

@@ -4,13 +4,13 @@ namespace MQTTnet.Client.Subscribing
 {
     public class MqttClientSubscribeResultItem
     {
-        public MqttClientSubscribeResultItem(TopicFilter topicFilter, MqttClientSubscribeResultCode resultCode)
+        public MqttClientSubscribeResultItem(MqttTopicFilter topicFilter, MqttClientSubscribeResultCode resultCode)
         {
             TopicFilter = topicFilter ?? throw new ArgumentNullException(nameof(topicFilter));
             ResultCode = resultCode;
         }
 
-        public TopicFilter TopicFilter { get; }
+        public MqttTopicFilter TopicFilter { get; }
 
         public MqttClientSubscribeResultCode ResultCode { get; }
     }

Source/MQTTnet/Client/Unsubscribing/MqttClientUnsubscribeOptionsBuilder.cs

@@ -44,7 +44,7 @@ namespace MQTTnet.Client.Unsubscribing
             return this;
         }
 
-        public MqttClientUnsubscribeOptionsBuilder WithTopicFilter(TopicFilter topicFilter)
+        public MqttClientUnsubscribeOptionsBuilder WithTopicFilter(MqttTopicFilter topicFilter)
         {
             if (topicFilter is null) throw new ArgumentNullException(nameof(topicFilter));
 

Source/MQTTnet/Formatter/V3/MqttV310PacketFormatter.cs

@@ -194,7 +194,7 @@ namespace MQTTnet.Formatter.V3
 
             while (!body.EndOfStream)
             {
-                var topicFilter = new TopicFilter
+                var topicFilter = new MqttTopicFilter
                 {
                     Topic = body.ReadStringWithLengthPrefix(),
                     QualityOfServiceLevel = (MqttQualityOfServiceLevel)body.ReadByte()

Source/MQTTnet/Formatter/V5/MqttV500PacketDecoder.cs

@@ -405,7 +405,7 @@ namespace MQTTnet.Formatter.V5
                 var retainAsPublished = (options & (1 << 3)) > 0;
                 var retainHandling = (MqttRetainHandling)((options >> 4) & 3);
 
-                packet.TopicFilters.Add(new TopicFilter
+                packet.TopicFilters.Add(new MqttTopicFilter
                 {
                     Topic = topic,
                     QualityOfServiceLevel = qos,

Source/MQTTnet/MqttTopicFilter.cs

@@ -1,9 +1,14 @@
 using MQTTnet.Protocol;
+using System;
 
 namespace MQTTnet
 {
-    // TODO: Consider renaming to "MqttTopicFilter"
-    public class TopicFilter
+    [Obsolete("Use MqttTopicFilter instead. It is just a renamed version to align with general namings in this lib.")]
+    public class TopicFilter : MqttTopicFilter
+    {
+    }
+
+    public class MqttTopicFilter
     {
         public string Topic { get; set; }
 

Source/MQTTnet/MqttTopicFilterBuilder.cs

@@ -0,0 +1,57 @@
+using MQTTnet.Exceptions;
+using MQTTnet.Protocol;
+using System;
+
+namespace MQTTnet
+{
+    [Obsolete("Use MqttTopicFilter instead. It is just a renamed version to align with general namings in this lib.")]
+    public class TopicFilterBuilder : MqttTopicFilterBuilder
+    {
+    }
+
+    public class MqttTopicFilterBuilder
+    {
+        MqttQualityOfServiceLevel _qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce;
+        string _topic;
+
+        public MqttTopicFilterBuilder WithTopic(string topic)
+        {
+            _topic = topic;
+            return this;
+        }
+
+        public MqttTopicFilterBuilder WithQualityOfServiceLevel(MqttQualityOfServiceLevel qualityOfServiceLevel)
+        {
+            _qualityOfServiceLevel = qualityOfServiceLevel;
+            return this;
+        }
+
+        public MqttTopicFilterBuilder WithAtLeastOnceQoS()
+        {
+            _qualityOfServiceLevel = MqttQualityOfServiceLevel.AtLeastOnce;
+            return this;
+        }
+
+        public MqttTopicFilterBuilder WithAtMostOnceQoS()
+        {
+            _qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce;
+            return this;
+        }
+
+        public MqttTopicFilterBuilder WithExactlyOnceQoS()
+        {
+            _qualityOfServiceLevel = MqttQualityOfServiceLevel.ExactlyOnce;
+            return this;
+        }
+
+        public MqttTopicFilter Build()
+        {
+            if (string.IsNullOrEmpty(_topic))
+            {
+                throw new MqttProtocolViolationException("Topic is not set.");
+            }
+
+            return new MqttTopicFilter { Topic = _topic, QualityOfServiceLevel = _qualityOfServiceLevel };
+        }
+    }
+}

Source/MQTTnet/Packets/MqttSubscribePacket.cs

@@ -7,7 +7,7 @@ namespace MQTTnet.Packets
     {
         public ushort? PacketIdentifier { get; set; }
 
-        public List<TopicFilter> TopicFilters { get; set; } = new List<TopicFilter>();
+        public List<MqttTopicFilter> TopicFilters { get; set; } = new List<MqttTopicFilter>();
 
         #region Added in MQTTv5
 

Source/MQTTnet/Server/IMqttRetainedMessagesManager.cs

@@ -16,6 +16,6 @@ namespace MQTTnet.Server
 
         Task<IList<MqttApplicationMessage>> GetMessagesAsync();
 
-        Task<IList<MqttApplicationMessage>> GetSubscribedMessagesAsync(ICollection<TopicFilter> topicFilters);
+        Task<IList<MqttApplicationMessage>> GetSubscribedMessagesAsync(ICollection<MqttTopicFilter> topicFilters);
     }
 }

Source/MQTTnet/Server/IMqttServer.cs

@@ -23,7 +23,7 @@ namespace MQTTnet.Server
         Task<IList<MqttApplicationMessage>> GetRetainedApplicationMessagesAsync();
         Task ClearRetainedApplicationMessagesAsync();
 
-        Task SubscribeAsync(string clientId, ICollection<TopicFilter> topicFilters);
+        Task SubscribeAsync(string clientId, ICollection<MqttTopicFilter> topicFilters);
         Task UnsubscribeAsync(string clientId, ICollection<string> topicFilters);
 
         Task StartAsync(IMqttServerOptions options);

Source/MQTTnet/Server/IMqttServerPersistedSession.cs

@@ -9,7 +9,7 @@ namespace MQTTnet.Server
 
         IDictionary<object, object> Items { get; }
 
-        IList<TopicFilter> Subscriptions { get; }
+        IList<MqttTopicFilter> Subscriptions { get; }
 
         MqttApplicationMessage WillMessage { get; }
 

Source/MQTTnet/Server/MqttClientConnection.cs

@@ -282,7 +282,7 @@ namespace MQTTnet.Server
             _cancellationToken.Cancel(false);
         }
 
-        async Task EnqueueSubscribedRetainedMessagesAsync(ICollection<TopicFilter> topicFilters)
+        async Task EnqueueSubscribedRetainedMessagesAsync(ICollection<MqttTopicFilter> topicFilters)
         {
             var retainedMessages = await _retainedMessagesManager.GetSubscribedMessagesAsync(topicFilters).ConfigureAwait(false);
             foreach (var applicationMessage in retainedMessages)

Source/MQTTnet/Server/MqttClientSession.cs

@@ -53,7 +53,7 @@ namespace MQTTnet.Server
             ApplicationMessagesQueue.Enqueue(applicationMessage, senderClientId, checkSubscriptionsResult.QualityOfServiceLevel, isRetainedApplicationMessage);
         }
 
-        public async Task SubscribeAsync(ICollection<TopicFilter> topicFilters)
+        public async Task SubscribeAsync(ICollection<MqttTopicFilter> topicFilters)
         {
             if (topicFilters is null) throw new ArgumentNullException(nameof(topicFilters));
 

Source/MQTTnet/Server/MqttClientSessionsManager.cs

@@ -108,7 +108,7 @@ namespace MQTTnet.Server
             _messageQueue.Enqueue(new MqttEnqueuedApplicationMessage(applicationMessage, sender));
         }
 
-        public Task SubscribeAsync(string clientId, ICollection<TopicFilter> topicFilters)
+        public Task SubscribeAsync(string clientId, ICollection<MqttTopicFilter> topicFilters)
         {
             if (clientId == null) throw new ArgumentNullException(nameof(clientId));
             if (topicFilters == null) throw new ArgumentNullException(nameof(topicFilters));

Source/MQTTnet/Server/MqttClientSubscriptionsManager.cs

@@ -9,7 +9,7 @@ namespace MQTTnet.Server
 {
     public class MqttClientSubscriptionsManager
     {
-        private readonly Dictionary<string, TopicFilter> _subscriptions = new Dictionary<string, TopicFilter>();
+        private readonly Dictionary<string, MqttTopicFilter> _subscriptions = new Dictionary<string, MqttTopicFilter>();
         private readonly MqttClientSession _clientSession;
         private readonly IMqttServerOptions _serverOptions;
         private readonly MqttServerEventDispatcher _eventDispatcher;
@@ -74,7 +74,7 @@ namespace MQTTnet.Server
             return result;
         }
 
-        public async Task SubscribeAsync(IEnumerable<TopicFilter> topicFilters)
+        public async Task SubscribeAsync(IEnumerable<MqttTopicFilter> topicFilters)
         {
             if (topicFilters == null) throw new ArgumentNullException(nameof(topicFilters));
 
@@ -206,7 +206,7 @@ namespace MQTTnet.Server
             }
         }
 
-        private async Task<MqttSubscriptionInterceptorContext> InterceptSubscribeAsync(TopicFilter topicFilter)
+        private async Task<MqttSubscriptionInterceptorContext> InterceptSubscribeAsync(MqttTopicFilter topicFilter)
         {
             var context = new MqttSubscriptionInterceptorContext(_clientSession.ClientId, topicFilter, _clientSession.Items);
             if (_serverOptions.SubscriptionInterceptor != null)

Source/MQTTnet/Server/MqttRetainedMessagesManager.cs

@@ -105,7 +105,7 @@ namespace MQTTnet.Server
             }
         }
 
-        public async Task<IList<MqttApplicationMessage>> GetSubscribedMessagesAsync(ICollection<TopicFilter> topicFilters)
+        public async Task<IList<MqttApplicationMessage>> GetSubscribedMessagesAsync(ICollection<MqttTopicFilter> topicFilters)
         {
             if (topicFilters == null) throw new ArgumentNullException(nameof(topicFilters));
 

Source/MQTTnet/Server/MqttServer.cs

@@ -87,7 +87,7 @@ namespace MQTTnet.Server
             return _retainedMessagesManager.GetMessagesAsync();
         }
 
-        public Task SubscribeAsync(string clientId, ICollection<TopicFilter> topicFilters)
+        public Task SubscribeAsync(string clientId, ICollection<MqttTopicFilter> topicFilters)
         {
             if (clientId == null) throw new ArgumentNullException(nameof(clientId));
             if (topicFilters == null) throw new ArgumentNullException(nameof(topicFilters));

Source/MQTTnet/Server/MqttServerClientSubscribedTopicEventArgs.cs

@@ -4,7 +4,7 @@ namespace MQTTnet.Server
 {
     public class MqttServerClientSubscribedTopicEventArgs : EventArgs
     {
-        public MqttServerClientSubscribedTopicEventArgs(string clientId, TopicFilter topicFilter)
+        public MqttServerClientSubscribedTopicEventArgs(string clientId, MqttTopicFilter topicFilter)
         {
             ClientId = clientId ?? throw new ArgumentNullException(nameof(clientId));
             TopicFilter = topicFilter ?? throw new ArgumentNullException(nameof(topicFilter));
@@ -12,6 +12,6 @@ namespace MQTTnet.Server
 
         public string ClientId { get; }
 
-        public TopicFilter TopicFilter { get; }
+        public MqttTopicFilter TopicFilter { get; }
     }
 }

Source/MQTTnet/Server/MqttServerEventDispatcher.cs

@@ -60,7 +60,7 @@ namespace MQTTnet.Server
             }
         }
 
-        public async Task SafeNotifyClientSubscribedTopicAsync(string clientId, TopicFilter topicFilter)
+        public async Task SafeNotifyClientSubscribedTopicAsync(string clientId, MqttTopicFilter topicFilter)
         {
             try
             {

Source/MQTTnet/Server/MqttServerExtensions.cs

@@ -1,10 +1,10 @@
-using System;
+using MQTTnet.Client.Publishing;
+using MQTTnet.Client.Receiving;
+using MQTTnet.Protocol;
+using System;
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
-using MQTTnet.Client.Publishing;
-using MQTTnet.Client.Receiving;
-using MQTTnet.Protocol;
 
 namespace MQTTnet.Server
 {
@@ -106,7 +106,7 @@ namespace MQTTnet.Server
             return server;
         }
 
-        public static Task SubscribeAsync(this IMqttServer server, string clientId, params TopicFilter[] topicFilters)
+        public static Task SubscribeAsync(this IMqttServer server, string clientId, params MqttTopicFilter[] topicFilters)
         {
             if (server == null) throw new ArgumentNullException(nameof(server));
             if (clientId == null) throw new ArgumentNullException(nameof(clientId));
@@ -121,7 +121,7 @@ namespace MQTTnet.Server
             if (clientId == null) throw new ArgumentNullException(nameof(clientId));
             if (topic == null) throw new ArgumentNullException(nameof(topic));
 
-            return server.SubscribeAsync(clientId, new TopicFilterBuilder().WithTopic(topic).WithQualityOfServiceLevel(qualityOfServiceLevel).Build());
+            return server.SubscribeAsync(clientId, new MqttTopicFilterBuilder().WithTopic(topic).WithQualityOfServiceLevel(qualityOfServiceLevel).Build());
         }
 
         public static Task SubscribeAsync(this IMqttServer server, string clientId, string topic)
@@ -130,7 +130,7 @@ namespace MQTTnet.Server
             if (clientId == null) throw new ArgumentNullException(nameof(clientId));
             if (topic == null) throw new ArgumentNullException(nameof(topic));
 
-            return server.SubscribeAsync(clientId, new TopicFilterBuilder().WithTopic(topic).Build());
+            return server.SubscribeAsync(clientId, new MqttTopicFilterBuilder().WithTopic(topic).Build());
         }
 
         public static Task UnsubscribeAsync(this IMqttServer server, string clientId, params string[] topicFilters)

Source/MQTTnet/Server/MqttSubscriptionInterceptorContext.cs

@@ -4,7 +4,7 @@ namespace MQTTnet.Server
 {
     public class MqttSubscriptionInterceptorContext
     {
-        public MqttSubscriptionInterceptorContext(string clientId, TopicFilter topicFilter, IDictionary<object, object> sessionItems)
+        public MqttSubscriptionInterceptorContext(string clientId, MqttTopicFilter topicFilter, IDictionary<object, object> sessionItems)
         {
             ClientId = clientId;
             TopicFilter = topicFilter;
@@ -13,7 +13,7 @@ namespace MQTTnet.Server
 
         public string ClientId { get; }
 
-        public TopicFilter TopicFilter { get; set; }
+        public MqttTopicFilter TopicFilter { get; set; }
 
         /// <summary>
         /// Gets or sets a key/value collection that can be used to share data within the scope of this session.

Source/MQTTnet/TopicFilterBuilder.cs

@@ -1,51 +0,0 @@
-using MQTTnet.Exceptions;
-using MQTTnet.Protocol;
-
-namespace MQTTnet
-{
-    public class TopicFilterBuilder
-    {
-        private MqttQualityOfServiceLevel _qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce;
-        private string _topic;
-
-        public TopicFilterBuilder WithTopic(string topic)
-        {
-            _topic = topic;
-            return this;
-        }
-
-        public TopicFilterBuilder WithQualityOfServiceLevel(MqttQualityOfServiceLevel qualityOfServiceLevel)
-        {
-            _qualityOfServiceLevel = qualityOfServiceLevel;
-            return this;
-        }
-
-        public TopicFilterBuilder WithAtLeastOnceQoS()
-        {
-            _qualityOfServiceLevel = MqttQualityOfServiceLevel.AtLeastOnce;
-            return this;
-        }
-
-        public TopicFilterBuilder WithAtMostOnceQoS()
-        {
-            _qualityOfServiceLevel = MqttQualityOfServiceLevel.AtMostOnce;
-            return this;
-        }
-
-        public TopicFilterBuilder WithExactlyOnceQoS()
-        {
-            _qualityOfServiceLevel = MqttQualityOfServiceLevel.ExactlyOnce;
-            return this;
-        }
-
-        public TopicFilter Build()
-        {
-            if (string.IsNullOrEmpty(_topic))
-            {
-                throw new MqttProtocolViolationException("Topic is not set.");
-            }
-
-            return new TopicFilter { Topic = _topic, QualityOfServiceLevel = _qualityOfServiceLevel };
-        }
-    }
-}