Implemented recommended dispose pattern for DeviceProviders

Author: DarthAffe

RGB.NET.Core/Devices/AbstractRGBDeviceProvider.cs

@@ -12,6 +12,8 @@ public abstract class AbstractRGBDeviceProvider : IRGBDeviceProvider
 {
     #region Properties & Fields
 
+    private bool _isDisposed = false;
+
     private readonly double _defaultUpdateRateHardLimit;
 
     /// <inheritdoc />
@@ -60,13 +62,17 @@ protected AbstractRGBDeviceProvider(double defaultUpdateRateHardLimit = 0)
         this._defaultUpdateRateHardLimit = defaultUpdateRateHardLimit;
     }
 
+    ~AbstractRGBDeviceProvider() => Dispose(false);
+
     #endregion
 
     #region Methods
 
     /// <inheritdoc />
     public bool Initialize(RGBDeviceType loadFilter = RGBDeviceType.All, bool throwExceptions = false)
     {
+        if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
+
         ThrowsExceptions = throwExceptions;
 
         try
@@ -108,6 +114,8 @@ public bool Initialize(RGBDeviceType loadFilter = RGBDeviceType.All, bool throwE
     /// <returns>The filtered collection of loaded devices.</returns>
     protected virtual IEnumerable<IRGBDevice> GetLoadedDevices(RGBDeviceType loadFilter)
     {
+        if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
+
         List<IRGBDevice> devices = new();
         foreach (IRGBDevice device in LoadDevices())
         {
@@ -152,6 +160,8 @@ protected virtual IEnumerable<IRGBDevice> GetLoadedDevices(RGBDeviceType loadFil
     /// <returns>The update trigger mapped to the specified id.</returns>
     protected virtual IDeviceUpdateTrigger GetUpdateTrigger(int id = -1, double? updateRateHardLimit = null)
     {
+        if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
+
         if (!UpdateTriggerMapping.TryGetValue(id, out IDeviceUpdateTrigger? updaeTrigger))
             UpdateTriggerMapping[id] = (updaeTrigger = CreateUpdateTrigger(id, updateRateHardLimit ?? _defaultUpdateRateHardLimit));
 
@@ -171,6 +181,8 @@ protected virtual IDeviceUpdateTrigger GetUpdateTrigger(int id = -1, double? upd
     /// </summary>
     protected virtual void Reset()
     {
+        if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
+
         foreach (IDeviceUpdateTrigger updateTrigger in UpdateTriggerMapping.Values)
             updateTrigger.Dispose();
 
@@ -192,6 +204,8 @@ protected virtual void Reset()
     /// <returns><c>true</c> if the device was added successfully; otherwise <c>false</c>.</returns>
     protected virtual bool AddDevice(IRGBDevice device)
     {
+        if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
+
         if (InternalDevices.Contains(device)) return false;
 
         InternalDevices.Add(device);
@@ -207,6 +221,8 @@ protected virtual bool AddDevice(IRGBDevice device)
     /// <returns><c>true</c> if the device was removed successfully; otherwise <c>false</c>.</returns>
     protected virtual bool RemoveDevice(IRGBDevice device)
     {
+        if (_isDisposed) throw new ObjectDisposedException(GetType().FullName);
+
         if (!InternalDevices.Remove(device)) return false;
 
         try { OnDevicesChanged(DevicesChangedEventArgs.CreateDevicesRemovedArgs(device)); } catch { /* we don't want to throw due to bad event handlers */ }
@@ -241,12 +257,26 @@ public virtual void Throw(Exception ex, bool isCritical = false)
     protected virtual void OnDevicesChanged(DevicesChangedEventArgs args) => DevicesChanged?.Invoke(this, args);
 
     /// <inheritdoc />
-    public virtual void Dispose()
+    public void Dispose()
     {
-        Reset();
+        if (_isDisposed) return;
+
+        try
+        {
+            Dispose(true);
+        }
+        catch { /* don't throw in dispose! */ }
 
         GC.SuppressFinalize(this);
+
+        _isDisposed = true;
     }
 
+    /// <summary>
+    /// Disposes the object and frees all resources.
+    /// </summary>
+    /// <param name="disposing"><c>true</c> if explicitely called through the Dispose-Method, <c>false</c> if called by the destructor.</param>
+    protected virtual void Dispose(bool disposing) => Reset();
+
     #endregion
 }

RGB.NET.Devices.Asus/AsusDeviceProvider.cs

@@ -80,15 +80,16 @@ protected override IEnumerable<IRGBDevice> LoadDevices()
     }
 
     /// <inheritdoc />
-    public override void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        base.Dispose();
+        base.Dispose(disposing);
 
         try { _sdk?.ReleaseControl(0); }
         catch { /* at least we tried */ }
 
         _devices = null;
         _sdk = null;
+        _instance = null;
     }
 
     #endregion

RGB.NET.Devices.CoolerMaster/CoolerMasterDeviceProvider.cs

@@ -94,12 +94,14 @@ protected override IEnumerable<IRGBDevice> LoadDevices()
     }
 
     /// <inheritdoc />
-    public override void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        base.Dispose();
+        base.Dispose(disposing);
 
         try { _CoolerMasterSDK.Reload(); }
         catch { /* Unlucky.. */ }
+
+        _instance = null;
     }
 
     #endregion

RGB.NET.Devices.Corsair/CorsairDeviceProvider.cs

@@ -300,12 +300,14 @@ private IEnumerable<ICorsairRGBDevice> LoadCorsairDevices()
     }
 
     /// <inheritdoc />
-    public override void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        base.Dispose();
+        base.Dispose(disposing);
 
         try { _CUESDK.CorsairDisconnect(); } catch { /* at least we tried */ }
         try { _CUESDK.UnloadCUESDK(); } catch { /* at least we tried */ }
+
+        _instance = null;
     }
 
     #endregion

RGB.NET.Devices.DMX/DMXDeviceProvider.cs

@@ -86,5 +86,13 @@ protected override IDeviceUpdateTrigger CreateUpdateTrigger(int id, double updat
         return updateTrigger;
     }
 
+    /// <inheritdoc />
+    protected override void Dispose(bool disposing)
+    {
+        base.Dispose(disposing);
+
+        _instance = null;
+    }
+
     #endregion
 }

RGB.NET.Devices.Debug/DebugDeviceProvider.cs

@@ -66,11 +66,13 @@ protected override IEnumerable<IRGBDevice> LoadDevices()
     }
 
     /// <inheritdoc />
-    public override void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        base.Dispose();
+        base.Dispose(disposing);
 
         _fakeDeviceDefinitions.Clear();
+
+        _instance = null;
     }
 
     #endregion

RGB.NET.Devices.Logitech/LogitechDeviceProvider.cs

@@ -254,17 +254,17 @@ protected override IEnumerable<IRGBDevice> LoadDevices()
     }
 
     /// <inheritdoc />
-    public override void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        base.Dispose();
+        base.Dispose(disposing);
 
         try { _LogitechGSDK.LogiLedRestoreLighting(); }
         catch { /* at least we tried */ }
 
         try { _LogitechGSDK.UnloadLogitechGSDK(); }
         catch { /* at least we tried */ }
 
-        GC.SuppressFinalize(this);
+        _instance = null;
     }
 
     #endregion

RGB.NET.Devices.Msi/MsiDeviceProvider.cs

@@ -98,14 +98,14 @@ protected override IEnumerable<IRGBDevice> LoadDevices()
     private void ThrowMsiError(int errorCode, bool isCritical = false) => Throw(new MysticLightException(errorCode, _MsiSDK.GetErrorMessage(errorCode)), isCritical);
 
     /// <inheritdoc />
-    public override void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        base.Dispose();
+        base.Dispose(disposing);
 
         try { _MsiSDK.UnloadMsiSDK(); }
         catch { /* at least we tried */ }
-
-        GC.SuppressFinalize(this);
+        
+        _instance = null;
     }
 
     #endregion

RGB.NET.Devices.Novation/NovationDeviceProvider.cs

@@ -67,5 +67,13 @@ protected override IEnumerable<IRGBDevice> LoadDevices()
         }
     }
 
+    /// <inheritdoc />
+    protected override void Dispose(bool disposing)
+    {
+        base.Dispose(disposing);
+
+        _instance = null;
+    }
+
     #endregion
 }

RGB.NET.Devices.OpenRGB/OpenRGBDeviceProvider.cs

@@ -107,22 +107,22 @@ protected override IEnumerable<IRGBDevice> LoadDevices()
                     continue;
                 }
 
-                if (device.Zones.Length == 0) 
+                if (device.Zones.Length == 0)
                     continue;
-                if (device.Zones.All(z => z.LedCount == 0)) 
+                if (device.Zones.All(z => z.LedCount == 0))
                     continue;
 
                 OpenRGBUpdateQueue updateQueue = new(GetUpdateTrigger(), i, openRgb, device);
-                
+
                 bool anyZoneHasSegments = device.Zones.Any(z => z.Segments.Length > 0);
-                bool splitDeviceByZones = anyZoneHasSegments ||  PerZoneDeviceFlag.HasFlag(Helper.GetRgbNetDeviceType(device.Type));
+                bool splitDeviceByZones = anyZoneHasSegments || PerZoneDeviceFlag.HasFlag(Helper.GetRgbNetDeviceType(device.Type));
 
                 if (!splitDeviceByZones)
                 {
                     yield return new OpenRGBGenericDevice(new OpenRGBDeviceInfo(device), updateQueue);
                     continue;
                 }
-                
+
                 int totalLedCount = 0;
 
                 foreach (Zone zone in device.Zones)
@@ -149,9 +149,9 @@ protected override IEnumerable<IRGBDevice> LoadDevices()
     }
 
     /// <inheritdoc />
-    public override void Dispose()
+    protected override void Dispose(bool disposing)
     {
-        base.Dispose();
+        base.Dispose(disposing);
 
         foreach (OpenRgbClient client in _clients)
         {
@@ -161,6 +161,8 @@ public override void Dispose()
 
         _clients.Clear();
         DeviceDefinitions.Clear();
+
+        _instance = null;
     }
 
     #endregion