Refactored auto-update to be SDK-wide

Devices/Generic/AbstractCueDevice.cs

@@ -29,35 +29,13 @@ namespace CUE.NET.Devices.Generic
     {
         #region Properties & Fields
 
-        private CancellationTokenSource _updateTokenSource;
-        private CancellationToken _updateToken;
-        private Task _updateTask;
-        private DateTime _lastUpdate = DateTime.Now;
+        private static DateTime _lastUpdate = DateTime.Now;
 
         /// <summary>
         /// Gets generic information provided by CUE for the device.
         /// </summary>
         public IDeviceInfo DeviceInfo { get; }
 
-        private UpdateMode _updateMode = UpdateMode.Manual;
-        /// <summary>
-        /// Gets or sets the update-mode for the device.
-        /// </summary>
-        public UpdateMode UpdateMode
-        {
-            get { return _updateMode; }
-            set
-            {
-                _updateMode = value;
-                CheckUpdateLoop();
-            }
-        }
-
-        /// <summary>
-        /// Gets or sets the update-frequency in seconds. (Calculate by using '1f / updates per second')
-        /// </summary>
-        public float UpdateFrequency { get; set; } = 1f / 30f;
-
         /// <summary>
         /// Gets the rectangle containing all LEDs of the device.
         /// </summary>
@@ -166,9 +144,7 @@ namespace CUE.NET.Devices.Generic
 
             // ReSharper disable once VirtualMemberCallInConstructor - I know, but I need this ...
             InitializeLeds();
-            DeviceRectangle = RectangleHelper.CreateRectangleFromRectangles(((IEnumerable<CorsairLed>)this).Select(x => x.LedRectangle));
-
-            CheckUpdateLoop();
+            DeviceRectangle = RectangleHelper.CreateRectangleFromRectangles((this).Select(x => x.LedRectangle));
         }
 
         #endregion
@@ -208,56 +184,6 @@ namespace CUE.NET.Devices.Generic
 
         #endregion
 
-        #region Update-Loop
-
-        /// <summary>
-        /// Checks if automatic updates should occur and starts/stops the update-loop if needed.
-        /// </summary>
-        /// <exception cref="ArgumentOutOfRangeException">Thrown if the requested update-mode is not available.</exception>
-        protected async void CheckUpdateLoop()
-        {
-            bool shouldRun;
-            switch (UpdateMode)
-            {
-                case UpdateMode.Manual:
-                    shouldRun = false;
-                    break;
-                case UpdateMode.Continuous:
-                    shouldRun = true;
-                    break;
-                default:
-                    throw new ArgumentOutOfRangeException();
-            }
-
-            if (shouldRun && _updateTask == null) // Start task
-            {
-                _updateTokenSource?.Dispose();
-                _updateTokenSource = new CancellationTokenSource();
-                _updateTask = Task.Factory.StartNew(UpdateLoop, (_updateToken = _updateTokenSource.Token));
-            }
-            else if (!shouldRun && _updateTask != null) // Stop task
-            {
-                _updateTokenSource.Cancel();
-                await _updateTask;
-                _updateTask.Dispose();
-                _updateTask = null;
-            }
-        }
-
-        private void UpdateLoop()
-        {
-            while (!_updateToken.IsCancellationRequested)
-            {
-                long preUpdateTicks = DateTime.Now.Ticks;
-                Update();
-                int sleep = (int)((UpdateFrequency * 1000f) - ((DateTime.Now.Ticks - preUpdateTicks) / 10000f));
-                if (sleep > 0)
-                    Thread.Sleep(sleep);
-            }
-        }
-
-        #endregion
-
         #region Update
 
         /// <summary>

Devices/ICueDevice.cs

@@ -10,6 +10,8 @@ using CUE.NET.Groups;
 
 namespace CUE.NET.Devices
 {
+    #region EventHandler
+    
     /// <summary>
     /// Represents the event-handler of the Exception-event.
     /// </summary>
@@ -45,26 +47,20 @@ namespace CUE.NET.Devices
     /// <param name="args">The arguments provided by the event.</param>
     public delegate void LedsUpdatedEventHandler(object sender, LedsUpdatedEventArgs args);
 
+    #endregion
+
     /// <summary>
     /// Represents a generic cue device.
     /// </summary>
     public interface ICueDevice : ILedGroup, IEnumerable<CorsairLed>
     {
+        #region Properties
+
         /// <summary>
         /// Gets generic information provided by CUE for the device.
         /// </summary>
         IDeviceInfo DeviceInfo { get; }
 
-        /// <summary>
-        /// Gets or sets the update-mode for the device.
-        /// </summary>
-        UpdateMode UpdateMode { get; set; }
-
-        /// <summary>
-        /// Gets or sets the update-frequency in seconds. (Calculate by using '1f / updates per second')
-        /// </summary>
-        float UpdateFrequency { get; set; }
-
         /// <summary>
         /// Gets the rectangle containing all LEDs of the device.
         /// </summary>
@@ -75,6 +71,10 @@ namespace CUE.NET.Devices
         /// </summary>
         IEnumerable<CorsairLed> Leds { get; }
 
+        #endregion
+
+        #region Indexer
+
         /// <summary>
         /// Gets the <see cref="CorsairLed" /> with the specified ID.
         /// </summary>
@@ -97,6 +97,10 @@ namespace CUE.NET.Devices
         /// <returns></returns>
         IEnumerable<CorsairLed> this[RectangleF referenceRect, float minOverlayPercentage = 0.5f] { get; }
 
+        #endregion
+
+        #region Events
+
         // ReSharper disable EventNeverSubscribedTo.Global
 
         /// <summary>
@@ -126,12 +130,21 @@ namespace CUE.NET.Devices
 
         // ReSharper restore EventNeverSubscribedTo.Global
 
+        #endregion
+
+        #region Methods
+
         /// <summary>
         /// Perform an update for all dirty keys, or all keys if flushLeds is set to true.
         /// </summary>
         /// <param name="flushLeds">Specifies whether all keys (including clean ones) should be updated.</param>
         void Update(bool flushLeds = false);
 
+        /// <summary>
+        /// Attaches the given ledgroup.
+        /// </summary>
+        /// <param name="ledGroup">The ledgroup to attach.</param>
+        /// <returns><c>true</c> if the ledgroup could be attached; otherwise, <c>false</c>.</returns>
         bool AttachLedGroup(ILedGroup ledGroup);
 
         /// <summary>
@@ -140,5 +153,7 @@ namespace CUE.NET.Devices
         /// <param name="ledGroup">The ledgroup to detached.</param>
         /// <returns><c>true</c> if the ledgroup could be detached; otherwise, <c>false</c>.</returns>
         bool DetachLedGroup(ILedGroup ledGroup);
+
+        #endregion
     }
 }