Updated to use QoS read from configuration file

PatrickRitchie · PatrickRitchie · commit 0f156263da8d · 2024-10-15T22:24:50.000-04:00
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);
+                    _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/Module.cs b/agent/Modules/MTConnect.NET-AgentModule-MqttRelay/Module.cs
@@ -57,7 +57,7 @@ public Module(IMTConnectAgentBroker mtconnectAgent, object configuration) : base
 
                 case MqttTopicStructure.Entity:
 
-                    _entityServer = new MTConnectMqttEntityServer(_configuration.TopicPrefix, _configuration.DocumentFormat);
+                    _entityServer = new MTConnectMqttEntityServer(_configuration.TopicPrefix, _configuration.DocumentFormat, _configuration.QoS);
                     Agent.DeviceAdded += AgentDeviceAdded;
                     Agent.ObservationAdded += AgentObservationAdded;
                     Agent.AssetAdded += AgentAssetAdded;
diff --git a/libraries/MTConnect.NET-MQTT/Configurations/IMTConnectMqttEntityServerConfiguration.cs b/libraries/MTConnect.NET-MQTT/Configurations/IMTConnectMqttEntityServerConfiguration.cs
@@ -14,5 +14,10 @@ public interface IMTConnectMqttEntityServerConfiguration
         /// 
         /// </summary>
         string DocumentFormat { get; }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        int QoS { get; set; }
     }
 }
diff --git a/libraries/MTConnect.NET-MQTT/Configurations/MTConnectMqttEntityServerConfiguration.cs b/libraries/MTConnect.NET-MQTT/Configurations/MTConnectMqttEntityServerConfiguration.cs
@@ -1,4 +1,4 @@
-﻿// Copyright (c) 2023 TrakHound Inc., All Rights Reserved.
+﻿// Copyright (c) 2024 TrakHound Inc., All Rights Reserved.
 // TrakHound Inc. licenses this file to you under the MIT license.
 
 namespace MTConnect.Configurations
@@ -9,11 +9,14 @@ public class MTConnectMqttEntityServerConfiguration : IMTConnectMqttEntityServer
 
         public string DocumentFormat { get; set; }
 
+        public int QoS { get; set; }
+
 
         public MTConnectMqttEntityServerConfiguration()
         {
             TopicPrefix = "MTConnect";
             DocumentFormat = "JSON";
+            QoS = 0;
         }
     }
 }
diff --git a/libraries/MTConnect.NET-MQTT/MTConnectMqttEntityServer.cs b/libraries/MTConnect.NET-MQTT/MTConnectMqttEntityServer.cs
@@ -23,11 +23,12 @@ public class MTConnectMqttEntityServer
         public string TopicPrefix => _configuration.TopicPrefix;
 
 
-        public MTConnectMqttEntityServer(string topicPrefix = null, string documentFormat = DocumentFormat.JSON)
+        public MTConnectMqttEntityServer(string topicPrefix = null, string documentFormat = DocumentFormat.JSON, int qos = 0)
         {
             var configuration = new MTConnectMqttEntityServerConfiguration();
             configuration.TopicPrefix = topicPrefix;
             configuration.DocumentFormat = documentFormat;
+            configuration.QoS = qos;
             _configuration = configuration;
         }
 
@@ -81,7 +82,7 @@ private MqttApplicationMessage CreateMessage(IDevice device)
                     messageBuilder.WithTopic(topic);
                     messageBuilder.WithPayload(formatResult.Content);
                     messageBuilder.WithRetainFlag(true);
-                    messageBuilder.WithQualityOfServiceLevel(MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce);
+                    messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));
                     return messageBuilder.Build();
                 }
             }
@@ -168,7 +169,7 @@ private MqttApplicationMessage CreateMessage(IObservation observation)
                         messageBuilder.WithTopic(topic);
                         messageBuilder.WithPayload(formatResult.Content);
                         messageBuilder.WithRetainFlag(true);
-                        messageBuilder.WithQualityOfServiceLevel(MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce);
+                        messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));
                         return messageBuilder.Build();
                     }
                 }
@@ -200,7 +201,7 @@ private MqttApplicationMessage CreateMessage(IEnumerable<IObservation> observati
                         messageBuilder.WithTopic(topic);
                         messageBuilder.WithPayload(formatResult.Content);
                         messageBuilder.WithRetainFlag(true);
-                        messageBuilder.WithQualityOfServiceLevel(MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce);
+                        messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));
                         return messageBuilder.Build();
                     }
                 }
@@ -253,12 +254,19 @@ private MqttApplicationMessage CreateMessage(IAsset asset)
                     messageBuilder.WithTopic(topic);
                     messageBuilder.WithPayload(formatResult.Content);
                     messageBuilder.WithRetainFlag(true);
-                    messageBuilder.WithQualityOfServiceLevel(MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce);
+                    messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));
                     return messageBuilder.Build();
                 }
             }
 
             return null;
         }
+
+        private static MQTTnet.Protocol.MqttQualityOfServiceLevel GetQualityOfService(int qos)
+        {
+            if (qos == 1) return MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce;
+            else if (qos == 2) return MQTTnet.Protocol.MqttQualityOfServiceLevel.ExactlyOnce;
+            else return MQTTnet.Protocol.MqttQualityOfServiceLevel.AtMostOnce;
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,10 @@ public interface IMTConnectMqttEntityServerConfiguration`
`14`	`14`	`///`
`15`	`15`	`/// </summary>`
`16`	`16`	`string DocumentFormat { get; }`
	`17`	`+`
	`18`	`+ /// <summary>`
	`19`	`+ ///`
	`20`	`+ /// </summary>`
	`21`	`+ int QoS { get; set; }`
`17`	`22`	`}`
`18`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-// Copyright (c) 2023 TrakHound Inc., All Rights Reserved.`
	`1`	`+// Copyright (c) 2024 TrakHound Inc., All Rights Reserved.`
`2`	`2`	`// TrakHound Inc. licenses this file to you under the MIT license.`
`3`	`3`
`4`	`4`	`namespace MTConnect.Configurations`
`@@ -9,11 +9,14 @@ public class MTConnectMqttEntityServerConfiguration : IMTConnectMqttEntityServer`
`9`	`9`
`10`	`10`	`public string DocumentFormat { get; set; }`
`11`	`11`
	`12`	`+ public int QoS { get; set; }`
	`13`	`+`
`12`	`14`
`13`	`15`	`public MTConnectMqttEntityServerConfiguration()`
`14`	`16`	`{`
`15`	`17`	`TopicPrefix = "MTConnect";`
`16`	`18`	`DocumentFormat = "JSON";`
	`19`	`+ QoS = 0;`
`17`	`20`	`}`
`18`	`21`	`}`
`19`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,12 @@ public class MTConnectMqttEntityServer`
`23`	`23`	`public string TopicPrefix => _configuration.TopicPrefix;`
`24`	`24`
`25`	`25`
`26`		`- public MTConnectMqttEntityServer(string topicPrefix = null, string documentFormat = DocumentFormat.JSON)`
	`26`	`+ public MTConnectMqttEntityServer(string topicPrefix = null, string documentFormat = DocumentFormat.JSON, int qos = 0)`
`27`	`27`	`{`
`28`	`28`	`var configuration = new MTConnectMqttEntityServerConfiguration();`
`29`	`29`	`configuration.TopicPrefix = topicPrefix;`
`30`	`30`	`configuration.DocumentFormat = documentFormat;`
	`31`	`+ configuration.QoS = qos;`
`31`	`32`	`_configuration = configuration;`
`32`	`33`	`}`
`33`	`34`
`@@ -81,7 +82,7 @@ private MqttApplicationMessage CreateMessage(IDevice device)`
`81`	`82`	`messageBuilder.WithTopic(topic);`
`82`	`83`	`messageBuilder.WithPayload(formatResult.Content);`
`83`	`84`	`messageBuilder.WithRetainFlag(true);`
`84`		`- messageBuilder.WithQualityOfServiceLevel(MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce);`
	`85`	`+ messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));`
`85`	`86`	`return messageBuilder.Build();`
`86`	`87`	`}`
`87`	`88`	`}`
`@@ -168,7 +169,7 @@ private MqttApplicationMessage CreateMessage(IObservation observation)`
`168`	`169`	`messageBuilder.WithTopic(topic);`
`169`	`170`	`messageBuilder.WithPayload(formatResult.Content);`
`170`	`171`	`messageBuilder.WithRetainFlag(true);`
`171`		`- messageBuilder.WithQualityOfServiceLevel(MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce);`
	`172`	`+ messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));`
`172`	`173`	`return messageBuilder.Build();`
`173`	`174`	`}`
`174`	`175`	`}`
`@@ -200,7 +201,7 @@ private MqttApplicationMessage CreateMessage(IEnumerable<IObservation> observati`
`200`	`201`	`messageBuilder.WithTopic(topic);`
`201`	`202`	`messageBuilder.WithPayload(formatResult.Content);`
`202`	`203`	`messageBuilder.WithRetainFlag(true);`
`203`		`- messageBuilder.WithQualityOfServiceLevel(MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce);`
	`204`	`+ messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));`
`204`	`205`	`return messageBuilder.Build();`
`205`	`206`	`}`
`206`	`207`	`}`
`@@ -253,12 +254,19 @@ private MqttApplicationMessage CreateMessage(IAsset asset)`
`253`	`254`	`messageBuilder.WithTopic(topic);`
`254`	`255`	`messageBuilder.WithPayload(formatResult.Content);`
`255`	`256`	`messageBuilder.WithRetainFlag(true);`
`256`		`- messageBuilder.WithQualityOfServiceLevel(MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce);`
	`257`	`+ messageBuilder.WithQualityOfServiceLevel(GetQualityOfService(_configuration.QoS));`
`257`	`258`	`return messageBuilder.Build();`
`258`	`259`	`}`
`259`	`260`	`}`
`260`	`261`
`261`	`262`	`return null;`
`262`	`263`	`}`
	`264`	`+`
	`265`	`+ private static MQTTnet.Protocol.MqttQualityOfServiceLevel GetQualityOfService(int qos)`
	`266`	`+ {`
	`267`	`+ if (qos == 1) return MQTTnet.Protocol.MqttQualityOfServiceLevel.AtLeastOnce;`
	`268`	`+ else if (qos == 2) return MQTTnet.Protocol.MqttQualityOfServiceLevel.ExactlyOnce;`
	`269`	`+ else return MQTTnet.Protocol.MqttQualityOfServiceLevel.AtMostOnce;`
	`270`	`+ }`
`263`	`271`	`}`
`264`	`272`	`}`