Adding an option to disable monitoring of the route file (#24)

Author: HEskandari

src/NServiceBus.FileBasedRouting/FileBasedRoutingConfigExtensions.cs

@@ -16,6 +16,20 @@ public static void UseFileBasedRouting(this RoutingSettings config)
             config.GetSettings().EnableFeatureByDefault<FileBasedRoutingFeature>();
         }
 
+        /// <summary>
+        /// Enables routing configured with the routing configuration file.
+        /// </summary>
+        /// <param name="config">The configuration object.</param>
+        /// <param name="updateInterval">The interval the route file should be checked for changes.</param>
+        public static void UseFileBasedRouting(this RoutingSettings config, TimeSpan updateInterval)
+        {
+            if (updateInterval < TimeSpan.Zero)
+                throw new ArgumentOutOfRangeException(nameof(updateInterval), "Update interval cannot be negative.");
+
+            config.GetSettings().Set(FileBasedRoutingFeature.RouteFileUpdateInterval, updateInterval);
+            config.GetSettings().EnableFeatureByDefault<FileBasedRoutingFeature>();
+        }
+
         /// <summary>
         /// Enables routing configured with the routing configuration file under <paramref name="configurationFilePath"/>
         /// </summary>
@@ -26,6 +40,17 @@ public static void UseFileBasedRouting(this RoutingSettings config, string confi
             config.UseFileBasedRouting(UriHelper.FilePathToUri(configurationFilePath));
         }
 
+        /// <summary>
+        /// Enables routing configured with the routing configuration file under <paramref name="configurationFilePath"/>
+        /// </summary>
+        /// <param name="config">The configuration object.</param>
+        /// <param name="configurationFilePath">The path to the configuration file.</param>
+        /// <param name="updateInterval">The interval the route file should be checked for changes.</param>
+        public static void UseFileBasedRouting(this RoutingSettings config, string configurationFilePath, TimeSpan updateInterval)
+        {
+            config.UseFileBasedRouting(UriHelper.FilePathToUri(configurationFilePath), updateInterval);
+        }
+
         /// <summary>
         /// Enables routing configured with the routing configuration file under <paramref name="configurationFileUri"/>
         /// </summary>
@@ -36,5 +61,21 @@ public static void UseFileBasedRouting(this RoutingSettings config, Uri configur
             config.GetSettings().Set(FileBasedRoutingFeature.RoutingFilePathKey, configurationFileUri);
             config.GetSettings().EnableFeatureByDefault<FileBasedRoutingFeature>();
         }
+
+        /// <summary>
+        /// Enables routing configured with the routing configuration file under <paramref name="configurationFileUri"/>
+        /// </summary>
+        /// <param name="config">The configuration object.</param>
+        /// <param name="configurationFileUri">The <see cref="Uri"/> to the configuration file.</param>
+        /// <param name="updateInterval">The interval the route file should be checked for changes.</param>
+        public static void UseFileBasedRouting(this RoutingSettings config, Uri configurationFileUri, TimeSpan updateInterval)
+        {
+            if (updateInterval < TimeSpan.Zero)
+                throw new ArgumentOutOfRangeException(nameof(updateInterval), "Update interval cannot be negative.");
+
+            config.GetSettings().Set(FileBasedRoutingFeature.RouteFileUpdateInterval, updateInterval);
+            config.GetSettings().Set(FileBasedRoutingFeature.RoutingFilePathKey, configurationFileUri);
+            config.GetSettings().EnableFeatureByDefault<FileBasedRoutingFeature>();
+        }
     }
 }

src/NServiceBus.FileBasedRouting/FileBasedRoutingFeature.cs

@@ -14,12 +14,14 @@ class FileBasedRoutingFeature : Feature
         static ILog log = LogManager.GetLogger<FileBasedRoutingFeature>();
 
         public const string RoutingFilePathKey = "NServiceBus.FileBasedRouting.RoutingFileUri";
+        public const string RouteFileUpdateInterval = "NServiceBus.FileBasedRouting.RouteFileUpdateInterval";
 
         public FileBasedRoutingFeature()
         {
-            Defaults(s=>
+            Defaults(s =>
             {
                 s.SetDefault(RoutingFilePathKey, UriHelper.FilePathToUri("endpoints.xml"));
+                s.SetDefault(RouteFileUpdateInterval, TimeSpan.FromSeconds(30));
                 s.SetDefault<UnicastSubscriberTable>(new UnicastSubscriberTable());
             });
         }
@@ -31,6 +33,7 @@ protected override void Setup(FeatureConfigurationContext context)
             var unicastRoutingTable = context.Settings.Get<UnicastRoutingTable>();
             var unicastSubscriberTable = context.Settings.Get<UnicastSubscriberTable>();
 
+            var routeFileUpdateInterval = context.Settings.Get<TimeSpan>(RouteFileUpdateInterval);
             var routingFileUri = context.Settings.Get<Uri>(RoutingFilePathKey);
             var routingFile = new XmlRoutingFileAccess(routingFileUri);
             var routingFileParser = new XmlRoutingFileParser();
@@ -41,7 +44,10 @@ protected override void Setup(FeatureConfigurationContext context)
             // ensure the routing file is valid and the routing table is populated before running FeatureStartupTasks
             UpdateRoutingTable(routingFileParser, routingFile, unicastRoutingTable, unicastSubscriberTable, nativeSends, nativePublishes);
 
-            context.RegisterStartupTask(new UpdateRoutingTask(() => UpdateRoutingTable(routingFileParser, routingFile, unicastRoutingTable, unicastSubscriberTable, nativeSends, nativePublishes)));
+            if (routeFileUpdateInterval > TimeSpan.Zero)
+            {
+                context.RegisterStartupTask(new UpdateRoutingTask(() => UpdateRoutingTable(routingFileParser, routingFile, unicastRoutingTable, unicastSubscriberTable, nativeSends, nativePublishes), routeFileUpdateInterval));
+            }
 
             // if the transport provides native pub/sub support, don't plug in the FileBased pub/sub storage.
             if (context.Settings.Get<TransportInfrastructure>().OutboundRoutingPolicy.Publishes == OutboundRoutingType.Unicast)
@@ -95,16 +101,18 @@ static void UpdateRoutingTable(XmlRoutingFileParser routingFileParser, XmlRoutin
         class UpdateRoutingTask : FeatureStartupTask, IDisposable
         {
             Action updateRoutingCallback;
-            Timer updateTimer;
+	        TimeSpan routeFileUpdateInterval;
+	        Timer updateTimer;
 
-            public UpdateRoutingTask(Action updateRoutingCallback)
+            public UpdateRoutingTask(Action updateRoutingCallback, TimeSpan routeFileUpdateInterval)
             {
-                this.updateRoutingCallback = updateRoutingCallback;
+	            this.updateRoutingCallback = updateRoutingCallback;
+	            this.routeFileUpdateInterval = routeFileUpdateInterval;
             }
 
             protected override Task OnStart(IMessageSession session)
             {
-                updateTimer = new Timer(state => updateRoutingCallback(), null, TimeSpan.FromSeconds(30), TimeSpan.FromSeconds(30));
+                updateTimer = new Timer(state => updateRoutingCallback(), null, routeFileUpdateInterval, routeFileUpdateInterval);
 
                 return Task.CompletedTask;
             }