Merge pull request #83 from virizar/set_qos_correctly_from_config

PatrickRitchie · web-flow · commit da0dc742e19b · 2024-10-17T22:23:55.000-04:00
Replaced instances of QoS with Qos
diff --git a/adapter/Modules/MTConnect.NET-AdapterModule-MQTT/Module.cs b/adapter/Modules/MTConnect.NET-AdapterModule-MQTT/Module.cs
@@ -162,7 +162,7 @@ public override bool AddObservations(IEnumerable<IObservationInput> observations
                 {
                     var messageBuilder = new MqttApplicationMessageBuilder();
                     messageBuilder.WithTopic($"{_configuration.Topic}/observations");
-                    messageBuilder.WithQualityOfServiceLevel((MQTTnet.Protocol.MqttQualityOfServiceLevel)_configuration.QoS);
+                    messageBuilder.WithQualityOfServiceLevel((MQTTnet.Protocol.MqttQualityOfServiceLevel)_configuration.Qos);
                     messageBuilder.WithPayload(formatResult.Content);
                     messageBuilder.WithRetainFlag(true);
 
@@ -185,7 +185,7 @@ public override bool AddAssets(IEnumerable<IAssetInput> assets)
                 {
                     var messageBuilder = new MqttApplicationMessageBuilder();
                     messageBuilder.WithTopic($"{_configuration.Topic}/assets");
-                    messageBuilder.WithQualityOfServiceLevel((MQTTnet.Protocol.MqttQualityOfServiceLevel)_configuration.QoS);
+                    messageBuilder.WithQualityOfServiceLevel((MQTTnet.Protocol.MqttQualityOfServiceLevel)_configuration.Qos);
                     messageBuilder.WithPayload(formatResult.Content);
                     messageBuilder.WithRetainFlag(true);
 
@@ -210,7 +210,7 @@ public override bool AddDevices(IEnumerable<IDeviceInput> devices)
                     {
                         var messageBuilder = new MqttApplicationMessageBuilder();
                         messageBuilder.WithTopic($"{_configuration.Topic}/device");
-                        messageBuilder.WithQualityOfServiceLevel((MQTTnet.Protocol.MqttQualityOfServiceLevel)_configuration.QoS);
+                        messageBuilder.WithQualityOfServiceLevel((MQTTnet.Protocol.MqttQualityOfServiceLevel)_configuration.Qos);
                         messageBuilder.WithPayload(formatResult.Content);
                         messageBuilder.WithRetainFlag(true);
 
diff --git a/adapter/Modules/MTConnect.NET-AdapterModule-MQTT/ModuleConfiguration.cs b/adapter/Modules/MTConnect.NET-AdapterModule-MQTT/ModuleConfiguration.cs
@@ -15,7 +15,7 @@ public class ModuleConfiguration
 
         public string ClientId { get; set; }
 
-        public int QoS { get; set; }
+        public int Qos { get; set; }
 
 
         public string CertificateAuthority { get; set; }
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttAdapter/Module.cs b/agent/Modules/MTConnect.NET-AgentModule-MqttAdapter/Module.cs
@@ -149,9 +149,9 @@ private async Task Worker()
 
                         if (!string.IsNullOrEmpty(_configuration.TopicPrefix))
                         {
-                            // Set QoS
+                            // Set Qos
                             MqttQualityOfServiceLevel qos;
-                            switch (_configuration.QoS)
+                            switch (_configuration.Qos)
                             {
                                 case 1: qos = MqttQualityOfServiceLevel.AtLeastOnce; break;
                                 case 2: qos = MqttQualityOfServiceLevel.ExactlyOnce; break;
@@ -161,7 +161,7 @@ private async Task Worker()
                             // Subscribe to Topic
                             await _mqttClient.SubscribeAsync($"{_configuration.TopicPrefix}/#", qos);
 
-                            Log(MTConnectLogLevel.Information, $"MQTT Adapter Subscribed to ({_configuration.TopicPrefix} @ QoS = {qos})");
+                            Log(MTConnectLogLevel.Information, $"MQTT Adapter Subscribed to ({_configuration.TopicPrefix} @ Qos = {qos})");
                         }
                         else
                         {
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttAdapter/MqttAdapterModuleConfiguration.cs b/agent/Modules/MTConnect.NET-AgentModule-MqttAdapter/MqttAdapterModuleConfiguration.cs
@@ -47,9 +47,9 @@ public class MqttAdapterModuleConfiguration
         public bool CleanSession { get; set; }
 
         /// <summary>
-        /// Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+        /// Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
         /// </summary>
-        public int QoS { get; set; }
+        public int Qos { get; set; }
 
 
         /// <summary>
@@ -98,7 +98,7 @@ public MqttAdapterModuleConfiguration()
         {
             Server = "localhost";
             Port = 1883;
-            QoS = 1;
+            Qos = 1;
             CleanSession = true;
             Timeout = 5000;
             ReconnectInterval = 10000;
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttAdapter/README-Nuget.md b/agent/Modules/MTConnect.NET-AgentModule-MqttAdapter/README-Nuget.md
@@ -31,7 +31,7 @@ modules:
 
 * `cleanSession` - Sets the CleanSession flag (true or false)
 
-* `qos` - Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+* `qos` - Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
 
 * `certificateAuthority` - The path to the Certificate Authority file
 
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttAdapter/README.md b/agent/Modules/MTConnect.NET-AgentModule-MqttAdapter/README.md
@@ -49,7 +49,7 @@ modules:
 
 * `cleanSession` - Sets the CleanSession flag (true or false)
 
-* `qos` - Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+* `qos` - Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
 
 * `certificateAuthority` - The path to the Certificate Authority file
 
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttBroker/Module.cs b/agent/Modules/MTConnect.NET-AgentModule-MqttBroker/Module.cs
@@ -56,7 +56,7 @@ public Module(IMTConnectAgentBroker mtconnectAgent, object configuration) : base
 
                 case MqttTopicStructure.Entity:
 
-                    _entityServer = new MTConnectMqttEntityServer(_configuration.TopicPrefix, _configuration.DocumentFormat, _configuration.QoS);
+                    _entityServer = new MTConnectMqttEntityServer(_configuration.TopicPrefix, _configuration.DocumentFormat, _configuration.Qos);
                     Agent.DeviceAdded += AgentDeviceAdded;
                     Agent.ObservationAdded += AgentObservationAdded;
                     Agent.AssetAdded += AgentAssetAdded;
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttBroker/MqttBrokerModuleConfiguration.cs b/agent/Modules/MTConnect.NET-AgentModule-MqttBroker/MqttBrokerModuleConfiguration.cs
@@ -40,9 +40,9 @@ public class MqttBrokerModuleConfiguration : IMTConnectMqttDocumentServerConfigu
         public int RestartInterval { get; set; }
 
         /// <summary>
-        /// Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+        /// Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
         /// </summary>
-        public int QoS { get; set; }
+        public int Qos { get; set; }
 
 
         /// <summary>
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttBroker/README-Nuget.md b/agent/Modules/MTConnect.NET-AgentModule-MqttBroker/README-Nuget.md
@@ -18,7 +18,7 @@ modules:
 
 * `timeout` - The timeout (in milliseconds) to use for connection and read/write
 
-* `qos` - Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+* `qos` - Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
 
 * `initialDelay` - The time (in milliseconds) to delay after initial Module start (to allow for TCP binding)
 
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttBroker/README.md b/agent/Modules/MTConnect.NET-AgentModule-MqttBroker/README.md
@@ -36,7 +36,7 @@ modules:
 
 * `timeout` - The timeout (in milliseconds) to use for connection and read/write
 
-* `qos` - Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+* `qos` - Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
 
 * `initialDelay` - The time (in milliseconds) to delay after initial Module start (to allow for TCP binding)
 
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/Module.cs b/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/Module.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) 2024 TrakHound Inc., All Rights Reserved.
+// Copyright (c) 2024 TrakHound Inc., All Rights Reserved.
 // TrakHound Inc. licenses this file to you under the MIT license.
 
 using MQTTnet;
@@ -57,7 +57,7 @@ public Module(IMTConnectAgentBroker mtconnectAgent, object configuration) : base
 
                 case MqttTopicStructure.Entity:
 
-                    _entityServer = new MTConnectMqttEntityServer(_configuration.TopicPrefix, _configuration.DocumentFormat, _configuration.QoS);
+                    _entityServer = new MTConnectMqttEntityServer(_configuration.TopicPrefix, _configuration.DocumentFormat, _configuration.Qos);
                     Agent.DeviceAdded += AgentDeviceAdded;
                     Agent.ObservationAdded += AgentObservationAdded;
                     Agent.AssetAdded += AgentAssetAdded;
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/MqttRelayModuleConfiguration.cs b/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/MqttRelayModuleConfiguration.cs
@@ -54,9 +54,9 @@ public class MqttRelayModuleConfiguration : IMTConnectMqttDocumentServerConfigur
         public bool CleanSession { get; set; }
 
         /// <summary>
-        /// Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+        /// Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
         /// </summary>
-        public int QoS { get; set; }
+        public int Qos { get; set; }
 
         /// <summary>
         /// Gets or Sets the TLS settings
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/README-Nuget.md b/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/README-Nuget.md
@@ -27,7 +27,7 @@ modules:
  
 * `clientId` - Sets the Client ID to use for the connection
 
-* `qos` - Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+* `qos` - Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
 
 * `useTls` - Sets whether to use TLS or not (true or false)
 
diff --git a/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/README.md b/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/README.md
@@ -45,7 +45,7 @@ modules:
  
 * `clientId` - Sets the Client ID to use for the connection
 
-* `qos` - Sets the Quality Of Service (QoS) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
+* `qos` - Sets the Quality Of Service (Qos) to use. 0 = At Most Once, 1 = At least Once, 2 = Exactly Once
 
 * `useTls` - Sets whether to use TLS or not (true or false)
 
diff --git a/libraries/MTConnect.NET-MQTT/Clients/MTConnectMqttClient.cs b/libraries/MTConnect.NET-MQTT/Clients/MTConnectMqttClient.cs
@@ -178,7 +178,7 @@ public MTConnectMqttClient(string server, int port = 1883, string deviceUuid = n
             configuration.DeviceUuid = deviceUuid;
             configuration.TopicPrefix = topicPrefix;
             configuration.ClientId = clientId;
-            configuration.QoS = qos;
+            configuration.Qos = qos;
             _configuration = configuration;
             _documentFormat = documentFormat;
 
diff --git a/libraries/MTConnect.NET-MQTT/Clients/MTConnectMqttExpandedClient.cs b/libraries/MTConnect.NET-MQTT/Clients/MTConnectMqttExpandedClient.cs
@@ -84,7 +84,7 @@ public class MTConnectMqttExpandedClient : IMTConnectEntityClient, IDisposable
 
         public int Port => _port;
 
-        public int QoS => _qos;
+        public int Qos => _qos;
 
         public int Interval => _interval;
 
@@ -166,7 +166,7 @@ public MTConnectMqttExpandedClient(IMTConnectMqttClientConfiguration configurati
                 _port = configuration.Port;
                 _interval = configuration.Interval;
                 _deviceUuid = configuration.DeviceUuid;
-                _qos = configuration.QoS;
+                _qos = configuration.Qos;
                 _username = configuration.Username;
                 _password = configuration.Password;
                 _clientId = configuration.ClientId;
@@ -657,7 +657,7 @@ private async void ProcessDevice(MqttApplicationMessage message)
         private async Task ProcessDeviceAgentUuid(MqttApplicationMessage message)
         {
             try
-            {             
+            {
                 var agentUuid = Encoding.UTF8.GetString(message.Payload);
 
                 await SubscribeToDeviceAgent(agentUuid);
diff --git a/libraries/MTConnect.NET-MQTT/Configurations/IMTConnectMqttClientConfiguration.cs b/libraries/MTConnect.NET-MQTT/Configurations/IMTConnectMqttClientConfiguration.cs
@@ -21,7 +21,7 @@ public interface IMTConnectMqttClientConfiguration
 
         string ClientId { get; set; }
 
-        int QoS { get; set; }
+        int Qos { get; set; }
 
         TlsConfiguration Tls { get; set; }
 
diff --git a/libraries/MTConnect.NET-MQTT/Configurations/IMTConnectMqttEntityServerConfiguration.cs b/libraries/MTConnect.NET-MQTT/Configurations/IMTConnectMqttEntityServerConfiguration.cs
@@ -18,6 +18,6 @@ public interface IMTConnectMqttEntityServerConfiguration
         /// <summary>
         /// 
         /// </summary>
-        int QoS { get; set; }
+        int Qos { get; set; }
     }
 }
diff --git a/libraries/MTConnect.NET-MQTT/Configurations/MTConnectMqttClientConfiguration.cs b/libraries/MTConnect.NET-MQTT/Configurations/MTConnectMqttClientConfiguration.cs
@@ -30,7 +30,7 @@ public class MTConnectMqttClientConfiguration : IMTConnectMqttClientConfiguratio
         public string ClientId { get; set; }
 
         [JsonPropertyName("qos")]
-        public int QoS { get; set; }
+        public int Qos { get; set; }
 
         [JsonPropertyName("tls")]
         public TlsConfiguration Tls { get; set; }
@@ -61,7 +61,7 @@ public MTConnectMqttClientConfiguration()
         {
             Server = "localhost";
             Port = 1883;
-            QoS = 1;
+            Qos = 1;
             RetryInterval = 5000;
             TopicPrefix = "MTConnect";
         }
diff --git a/libraries/MTConnect.NET-MQTT/Configurations/MTConnectMqttEntityServerConfiguration.cs b/libraries/MTConnect.NET-MQTT/Configurations/MTConnectMqttEntityServerConfiguration.cs
@@ -9,14 +9,14 @@ public class MTConnectMqttEntityServerConfiguration : IMTConnectMqttEntityServer
 
         public string DocumentFormat { get; set; }
 
-        public int QoS { get; set; }
+        public int Qos { get; set; }
 
 
         public MTConnectMqttEntityServerConfiguration()
         {
             TopicPrefix = "MTConnect";
             DocumentFormat = "JSON";
-            QoS = 0;
+            Qos = 0;
         }
     }
 }
diff --git a/libraries/MTConnect.NET-MQTT/MTConnectMqttEntityServer.cs b/libraries/MTConnect.NET-MQTT/MTConnectMqttEntityServer.cs
@@ -28,7 +28,7 @@ public MTConnectMqttEntityServer(string topicPrefix = null, string documentForma
             var configuration = new MTConnectMqttEntityServerConfiguration();
             configuration.TopicPrefix = topicPrefix;
             configuration.DocumentFormat = documentFormat;
-            configuration.QoS = qos;
+            configuration.Qos = qos;
             _configuration = configuration;
         }
 
@@ -82,7 +82,7 @@ private MqttApplicationMessage CreateMessage(IDevice device)
                     messageBuilder.WithTopic(topic);
                     messageBuilder.WithPayload(formatResult.Content);
                     messageBuilder.WithRetainFlag(true);
-                    messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));
+                    messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.Qos));
                     return messageBuilder.Build();
                 }
             }
@@ -169,7 +169,7 @@ private MqttApplicationMessage CreateMessage(IObservation observation)
                         messageBuilder.WithTopic(topic);
                         messageBuilder.WithPayload(formatResult.Content);
                         messageBuilder.WithRetainFlag(true);
-                        messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));
+                        messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.Qos));
                         return messageBuilder.Build();
                     }
                 }
@@ -201,7 +201,7 @@ private MqttApplicationMessage CreateMessage(IEnumerable<IObservation> observati
                         messageBuilder.WithTopic(topic);
                         messageBuilder.WithPayload(formatResult.Content);
                         messageBuilder.WithRetainFlag(true);
-                        messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));
+                        messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.Qos));
                         return messageBuilder.Build();
                     }
                 }
@@ -254,7 +254,7 @@ private MqttApplicationMessage CreateMessage(IAsset asset)
                     messageBuilder.WithTopic(topic);
                     messageBuilder.WithPayload(formatResult.Content);
                     messageBuilder.WithRetainFlag(true);
-                    messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));
+                    messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.Qos));
                     return messageBuilder.Build();
                 }
             }
diff --git a/libraries/MTConnect.NET-MQTT/MTConnectMqttRelay.cs b/libraries/MTConnect.NET-MQTT/MTConnectMqttRelay.cs
@@ -42,7 +42,7 @@ public class MTConnectMqttRelay : IDisposable
 
         public int Port => _configuration.Port;
 
-        public int QoS => _configuration.QoS;
+        public int Qos => _configuration.Qos;
 
         /// <summary>
         /// Gets or Sets the Interval in Milliseconds that the Client will attempt to reconnect if the connection fails
@@ -405,8 +405,8 @@ private async Task Publish(MqttApplicationMessage message)
                     // Set the Topic Prefix
                     if (!string.IsNullOrEmpty(TopicPrefix)) message.Topic = $"{TopicPrefix}/{message.Topic}";
 
-                    // Set QoS for Message
-                    message.QualityOfServiceLevel = (MQTTnet.Protocol.MqttQualityOfServiceLevel)QoS;
+                    // Set Qos for Message
+                    message.QualityOfServiceLevel = (MQTTnet.Protocol.MqttQualityOfServiceLevel)Qos;
 
                     await _mqttClient.PublishAsync(message);
                 }
@@ -428,8 +428,8 @@ private async Task Publish(IEnumerable<MqttApplicationMessage> messages)
                         // Set the Topic Prefix
                         if (!string.IsNullOrEmpty(TopicPrefix)) message.Topic = $"{TopicPrefix}/{message.Topic}";
 
-                        // Set QoS for Message
-                        message.QualityOfServiceLevel = (MQTTnet.Protocol.MqttQualityOfServiceLevel)QoS;
+                        // Set Qos for Message
+                        message.QualityOfServiceLevel = (MQTTnet.Protocol.MqttQualityOfServiceLevel)Qos;
 
                         await _mqttClient.PublishAsync(message);
                     }
@@ -487,7 +487,7 @@ private static string GetFilePath(string path)
         {
             var x = path;
             if (!Path.IsPathRooted(x))
-            {              
+            {
                 x = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, x);
             }
 

Original file line number	Diff line number	Diff line change
`@@ -149,9 +149,9 @@ private async Task Worker()`
`149`	`149`
`150`	`150`	`if (!string.IsNullOrEmpty(_configuration.TopicPrefix))`
`151`	`151`	`{`
`152`		`- // Set QoS`
	`152`	`+ // Set Qos`
`153`	`153`	`MqttQualityOfServiceLevel qos;`
`154`		`- switch (_configuration.QoS)`
	`154`	`+ switch (_configuration.Qos)`
`155`	`155`	`{`
`156`	`156`	`case 1: qos = MqttQualityOfServiceLevel.AtLeastOnce; break;`
`157`	`157`	`case 2: qos = MqttQualityOfServiceLevel.ExactlyOnce; break;`
`@@ -161,7 +161,7 @@ private async Task Worker()`
`161`	`161`	`// Subscribe to Topic`
`162`	`162`	`await _mqttClient.SubscribeAsync($"{_configuration.TopicPrefix}/#", qos);`
`163`	`163`
`164`		`- Log(MTConnectLogLevel.Information, $"MQTT Adapter Subscribed to ({_configuration.TopicPrefix} @ QoS = {qos})");`
	`164`	`+ Log(MTConnectLogLevel.Information, $"MQTT Adapter Subscribed to ({_configuration.TopicPrefix} @ Qos = {qos})");`
`165`	`165`	`}`
`166`	`166`	`else`
`167`	`167`	`{`